Skip to content

Commit

Permalink
Document the random crate feature
Browse files Browse the repository at this point in the history
  • Loading branch information
robertknight committed Mar 30, 2024
1 parent 6212df4 commit 68f3499
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
//! rten is a runtime for machine learning models.
//!
//! RTen uses models that are exported from other frameworks such as
//! PyTorch into [ONNX](https://onnx.ai) format and then converted into the
//! RTen uses models that are exported from other frameworks such as PyTorch
//! into [ONNX](https://onnx.ai) format and then converted into the
//! inference-optimized `.rten` format by the tools in this repository.
//!
//! # Loading and running models
//!
//! The basic workflow for loading and running a model is:
//!
//! 1. Load the model using [Model::load].
Expand All @@ -18,7 +20,21 @@
//! See the example projects in [rten-examples][rten_examples] to see how all
//! these pieces fit together.
//!
//! # Supported operators
//!
//! RTen currently implements a subset of [ONNX operators][onnx_operators]. See
//! the [`schema.fbs` FlatBuffers schema][schema_fbs] for currently supported
//! operators and attributes.
//!
//! Some operators require additional dependencies and are only available if
//! certain crate features are enabled:
//!
//! - The `random` feature enables operators that generate random numbers (eg.
//! `RandomUniform`).
//!
//! [rten_examples]: https://github.com/robertknight/rten/tree/main/rten-examples
//! [onnx_operators]: https://onnx.ai/onnx/operators/
//! [schema_fbs]: https://github.com/robertknight/rten/blob/main/src/schema.fbs
#![cfg_attr(
feature = "avx512",
feature(stdarch_x86_avx512),
Expand Down

0 comments on commit 68f3499

Please sign in to comment.