Skip to content

Commit

Permalink
minor update to readme (#197)
Browse files Browse the repository at this point in the history
  • Loading branch information
minghuaw authored Feb 3, 2025
1 parent 6930a24 commit 9913569
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion mlx-rs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ _[Blaze](https://runblaze.dev) supports this project by providing ultra-fast App

</div>

## Documentation

Due to known limitation of docsrs, we are hosting the documentation on github pages [here](https://oxideai.github.io/mlx-rs/mlx_rs/).

## Features

MLX is an array framework for machine learning on Apple Silicon. mlx-rs provides Rust bindings for MLX, allowing you to use MLX in your Rust projects.
Expand Down Expand Up @@ -64,7 +68,7 @@ mlx-rs = "0.21.0"

## Versioning

For simplicity, the main crate `mls-rs` follows MLX’s versioning, allowing you to easily see which MLX version you’re using under the hood. The `mlx-sys` crate follows the versioning of `mlx-c`, as that is the version from which the API is generated. The `mlx-macros` crate uses its own versioning, as those macros are developed independently by us.
For simplicity, the main crate `mls-rs` follows MLX’s versioning, allowing you to easily see which MLX version you’re using under the hood. The `mlx-sys` crate follows the versioning of `mlx-c`, as that is the version from which the API is generated.

## Community

Expand Down

0 comments on commit 9913569

Please sign in to comment.