Mushin: Automatic differentiation with type safe parallel computations

CI Security Codecov Crates Docs License

Mushin is a Japanese term used in martial arts that refers to the state of mind obtained by practice. At this point, a person relies not on what they think should be the next move, but what is their trained natural reaction (or instinct).

Description

Mushin is to Rust what Tensorflow is to Python. A library to build computational graphs and compute the gradients of outputs with respect to a given set of variables using reverse automatic differentatiation.

Internally it uses the arrayfire crate to provide parallel computations on specialized hardware, such as Nvidia CUDA GPUs, Intel MKL CPUs... For details on what devices are available and installation instructions for your OS, please checkout the arrayfire crate documentation. The installation of the arrayfire binaries is required for Mushin to work.

One clear benefit of this crate versus Tensorflow is Rust's strong type system. All operations performed on tensors during the graph build are checked at compile time for mathematical soundness, which means no runtime error after an hour of model training. If it compiles, it works. If at some point while building your horribly nested computational graph you make a mistake on the shape of a tensor you'll be stopped before feeling stupid.

Usage

First, install the arrayfire binaries as indicated by the arrayfire crate.

Then, add Mushin as one of your dependencies:

toml [dependencies] mushin = "0.2"

The following is a self-explanatory example of the basic usage of Mushin, for more details, please check the crate docs.

```rust use mushin::{Context, Values, Class, Gradients, add, matmul};

fn main() { let ctx = Context::new();

let x = ctx.tensor::<1, 1, 2, 3>(Values::Eye(3.0), Class::Constant);
let w = ctx.tensor::<1, 1, 3, 2>(Values::Normal, Class::Persistent("weights"));
let b = ctx.tensor::<1, 1, 3, 3>(Values::Fill(0.0), Class::Persistent("bias"));
let z = add(&b, &matmul(&w, &x));

let grads = Gradients::compute(&z);
let dz_dw = grads.wrt(&w);
let dz_db = grads.wrt(&b);

} ```

Roadmap

Contributing

If you find a vulnerability, bug or would like a new feature, open a new issue.

To introduce your changes into the codebase, submit a Pull Request.

Many thanks!

License

Mushin is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT, and COPYRIGHT for details.