diff --git a/README.md b/README.md index 3822f63..c2f6c7a 100644 --- a/README.md +++ b/README.md @@ -12,49 +12,10 @@ -----
-The Most Advanced Machine Learning Library In Rust. +Machine Learning in Rust
----- +[](https://github.com/smartcorelib/smartcore/actions/workflows/ci.yml) -To start getting familiar with the new Smartcore v0.5 API, there is now available a [**Jupyter Notebook environment repository**](https://github.com/smartcorelib/smartcore-jupyter). Please see instructions there, your feedback is valuable for the future of the library. - -## Developers -Contributions welcome, please start from [CONTRIBUTING and other relevant files](.github/CONTRIBUTING.md). - -### Walkthrough: traits system and basic structures - -#### numbers -The library is founded on basic traits provided by `num-traits`. Basic traits are in `src/numbers`. These traits are used to define all the procedures in the library to make everything safer and provide constraints to what implementations can handle. - -#### linalg -`numbers` are made at use in linear algebra structures in the **`src/linalg/basic`** module. These sub-modules define the traits used all over the code base. - -* *arrays*: In particular data structures like `Array`, `Array1` (1-dimensional), `Array2` (matrix, 2-D); plus their "views" traits. Views are used to provide no-footprint access to data, they have composed traits to allow writing (mutable traits: `MutArray`, `ArrayViewMut`, ...). -* *matrix*: This provides the main entrypoint to matrices operations and currently the only structure provided in the shape of `struct DenseMatrix`. A matrix can be instantiated and automatically make available all the traits in "arrays" (sparse matrices implementation will be provided). -* *vector*: Convenience traits are implemented for `std::Vec` to allow extensive reuse. - -These are all traits and by definition they do not allow instantiation. For instantiable structures see implementation like `DenseMatrix` with relative constructor. - -#### linalg/traits -The traits in `src/linalg/traits` are closely linked to Linear Algebra's theoretical framework. These traits are used to specify characteristics and constraints for types accepted by various algorithms. For example these allow to define if a matrix is `QRDecomposable` and/or `SVDDecomposable`. See docstring for referencese to theoretical framework. - -As above these are all traits and by definition they do not allow instantiation. They are mostly used to provide constraints for implementations. For example, the implementation for Linear Regression requires the input data `X` to be in `smartcore`'s trait system `Array2