docs/all: refactor the cargo page

Cargo.toml

@@ -14,10 +14,10 @@ keywords = ["deep-learning", "neural-networks", "machine-learning", "framework"]
 license = "MIT"
 
 [dependencies]
-phloem = "0.2.3"
+phloem = "0.2.4"
 rblas = "0.0.9"
 log = "0.3.2"
-clippy = "0.0.22"
+clippy = "0.0.23"
 
 [features]
 default = []

src/layer.rs

@@ -1,3 +1,5 @@
+//! Provides the generics and interfaces for the specific [Layers][layers].
+//! [layers]: ../layers/index.html
 use math::*;
 use phloem::{Blob, Numeric};
 use shared_memory::{ArcLock, HeapBlob};

src/lib.rs

@@ -24,14 +24,14 @@
 //! performant and easy-to-use Deep Learning Framework.
 //! These principles direct our decisions on Leaf and related projects.
 //!
-//! * __Performance__:</br>
+//! * __Cutting Edge Performance__:</br>
 //! For research and industry speed and efficency are curcial for
 //! state-of-the-art machine learning over massive data and networks.
-//! * __Architecture__:</br>
+//! * __Open and Expressive Architecture__:</br>
 //! Designing an open architecture that follows best practices and concepts in
 //! Engineering such as modularity, flexibility and expressiveness is critical
 //! to stimulate future innovation.
-//! * __Documentation__:</br>
+//! * __Clear and Transparent Documentation__:</br>
 //! A well-written documentation that addresses both concepts and
 //! implementations, empowers developers and researchers to contribute their
 //! unique experience to the project for the benefit of everyone.
@@ -83,11 +83,8 @@ extern crate rblas;
 extern crate phloem;
 pub mod shared_memory;
 mod math;
-/// The Layer and Layer Interface
 pub mod layer;
 pub mod layers;
-/// The Solver
 pub mod solver;
-/// The specific Solvers
 pub mod solvers;
 pub mod network;

src/shared_memory.rs

@@ -1,4 +1,9 @@
-//! Specifies shared memory ...
+//!
+//!
+//! This is quite unimportant and might be refactored soon.
+//!
+//! See [Issue #22][issue] for more informations.
+//! [issue]: https://github.com/autumnai/leaf/issues/22
 use std::sync::{Arc, RwLock};
 use phloem::Blob;
 

src/solver.rs

@@ -1,3 +1,5 @@
+//! Provides the generics and interfaces for the specific [Solvers][solvers].
+//! [solvers]: ../solvers/index.html
 use shared_memory::*;
 use network::*;
 use solvers::*;

src/solvers/mod.rs

@@ -1,3 +1,5 @@
+//! Provides the trainers for the [Network][network].
+//! [network]: ../network/index.html
 pub use self::sgd::SGD;
 
 /// Stochastic Gradient Descent