Prepare for release 0.1.0-rc.1 (#11)

* Fill more metadata in Cargo.toml * Remove 'extension-' prefix from features names * Implement common traints for structs and enums * Remove re-use at lib level * Crate documentation * Change version to 0.1.0-rc.1 * Avoid linking to static libs when building docs * Enable all features when built by docs.rs
barakugav · Aug 3, 2024 · c33457c · c33457c
1 parent 69092fc
commit c33457c
Show file tree

Hide file tree

Showing 22 changed files with 845 additions and 79 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ target/
 *.pdb
 
 .vscode/
+.venv/
diff --git a/Cargo.toml b/Cargo.toml
@@ -7,14 +7,38 @@ members = [
 
 [package]
 name = "executorch"
-version = "0.1.0"
+version = "0.1.0-rc.1"
 authors = ["Barak Ugav <barakugav@gmail.com>"]
 edition = "2021"
+description = "Rust bindings for ExecuTorch - On-device AI across mobile, embedded and edge for PyTorch"
+readme = "README.md"
 repository = "https://github.com/barakugav/executorch-rs"
 license = "Apache-2.0"
+keywords = [
+ "executorch",
+ "pytorch",
+ "ai",
+ "ml",
+ "machine-learning",
+ "mobile",
+ "embedded",
+ "edge-device",
+ "bindings",
+]
+categories = [
+ "algorithms",
+ "mathematics",
+ "embedded",
+ "no-std",
+ "no-std::no-alloc",
+]
+include = ["Cargo.toml", "src/", "README.md", "LICENSE"]
+
+[package.metadata.docs.rs]
+features = ["data-loader", "module"]
 
 [dependencies]
-executorch-sys = { path = "executorch-sys" }
+executorch-sys = { path = "executorch-sys", version = "0.1.0-rc.1" }
 ndarray = "0.15.6"
 log = "0.4.22"
 
@@ -24,5 +48,5 @@ cc = "1.1.6"
 envsubst = "0.2.1"
 
 [features]
-extension-data-loader = ["executorch-sys/extension-data-loader"]
-extension-module = ["executorch-sys/extension-module"]
+data-loader = ["executorch-sys/data-loader"]
+module = ["executorch-sys/module"]
diff --git a/README.md b/README.md
@@ -28,7 +28,9 @@ with open("model.pte", "wb") as file:
 ```
 Execute the model in Rust:
 ```rust
-use executorch::{EValue, Module, Tag, Tensor, TensorImpl};
+use executorch::evalue::{EValue, Tag};
+use executorch::module::Module;
+use executorch::tensor::{Tensor, TensorImpl};
 use ndarray::array;
 
 let mut module = Module::new("model.pte", None);
@@ -45,10 +47,10 @@ let outputs = module.forward(&[input_evalue1, input_evalue2]).unwrap();
 assert_eq!(outputs.len(), 1);
 let output = outputs.into_iter().next().unwrap();
 assert_eq!(output.tag(), Some(Tag::Tensor));
-let output = output.as_tensor().as_array::<f32>();
+let output = output.as_tensor();
 
 println!("Output tensor computed: {:?}", output);
-assert_eq!(output, array![2.0].into_dyn());
+assert_eq!(array![2.0_f32], output.as_array());
 ```
 See `example/hello_world_add` and `example/hello_world_add_module` for the complete examples.
 
@@ -121,6 +123,6 @@ println!("cargo::rustc-link-search={}/kernels/portable/", libs_dir);
 Note that the `portable_ops_lib` is linked with `+whole-archive` to ensure that all symbols are included in the binary.
 
 ## Cargo Features
-- `default`: disables all features.
-- `extension-data-loader`: include the `FileDataLoader` strut. The `libextension_data_loader.a` static library is required, compile C++ `executorch` with `EXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON`.
-- `extension-module`: include the `Module` strut. The `libextension_module_static.a` static library is required, compile C++ `executorch` with `EXECUTORCH_BUILD_EXTENSION_MODULE=ON`.
+By default all features are disabled.
+- `data-loader`: include the `FileDataLoader` struct. The `libextension_data_loader.a` static library is required, compile C++ `executorch` with `EXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON`.
+- `module`: include the `Module` struct. The `libextension_module_static.a` static library is required, compile C++ `executorch` with `EXECUTORCH_BUILD_EXTENSION_MODULE=ON`.
diff --git a/examples/hello_world_add/Cargo.toml b/examples/hello_world_add/Cargo.toml
@@ -5,7 +5,7 @@ version = "0.0.0"
 edition = "2021"
 
 [dependencies]
-executorch = { path = "../../", features = ["extension-data-loader"] }
+executorch = { path = "../../", features = ["data-loader"] }
 log = "0.4.22"
 env_logger = "0.11.3"
 ndarray = "0.15.6"

diff --git a/examples/hello_world_add/src/main.rs b/examples/hello_world_add/src/main.rs
@@ -1,11 +1,12 @@
 #![deny(warnings)]
 
 use executorch::data_loader::FileDataLoader;
+use executorch::evalue::{EValue, Tag};
+use executorch::memory::{HierarchicalAllocator, MallocMemoryAllocator, MemoryManager};
+use executorch::program::{Program, ProgramVerification};
+use executorch::tensor::{Tensor, TensorImpl};
 use executorch::util::Span;
-use executorch::{
- EValue, HierarchicalAllocator, MallocMemoryAllocator, MemoryManager, Program,
- ProgramVerification, Tag, Tensor, TensorImpl,
-};
+
 use ndarray::array;
 use std::vec;
 
@@ -14,7 +15,7 @@ fn main() {
  .filter_level(log::LevelFilter::Debug)
  .init();
 
- executorch::pal_init();
+ executorch::platform::pal_init();
 
  let mut file_data_loader = FileDataLoader::new("model.pte", None).unwrap();
 
@@ -57,10 +58,10 @@ fn main() {
  method_exe.set_input(&input_evalue2, 1).unwrap();
 
  let outputs = method_exe.execute().unwrap();
- let output = outputs.get_output(0);
+ let output = &outputs[0];
  assert_eq!(output.tag(), Some(Tag::Tensor));
- let output = output.as_tensor().as_array_dyn::<f32>();
+ let output = output.as_tensor();
 
  println!("Output tensor computed: {:?}", output);
- assert_eq!(output, array![2.0].into_dyn());
+ assert_eq!(array![2.0_f32], output.as_array());
 }
diff --git a/examples/hello_world_add_module/Cargo.toml b/examples/hello_world_add_module/Cargo.toml
@@ -5,10 +5,7 @@ version = "0.0.0"
 edition = "2021"
 
 [dependencies]
-executorch = { path = "../../", features = [
- "extension-data-loader",
- "extension-module",
-] }
+executorch = { path = "../../", features = ["data-loader", "module"] }
 log = "0.4.22"
 env_logger = "0.11.3"
 ndarray = "0.15.6"

diff --git a/examples/hello_world_add_module/src/main.rs b/examples/hello_world_add_module/src/main.rs
@@ -1,14 +1,16 @@
 #![deny(warnings)]
 
-use executorch::{EValue, Module, Tag, Tensor, TensorImpl};
+use executorch::evalue::{EValue, Tag};
+use executorch::module::Module;
+use executorch::tensor::{Tensor, TensorImpl};
 use ndarray::array;
 
 fn main() {
  env_logger::Builder::new()
  .filter_level(log::LevelFilter::Debug)
  .init();
 
- executorch::pal_init();
+ executorch::platform::pal_init();
 
  let mut module = Module::new("model.pte", None);
 
@@ -24,8 +26,8 @@ fn main() {
  assert_eq!(outputs.len(), 1);
  let output = outputs.into_iter().next().unwrap();
  assert_eq!(output.tag(), Some(Tag::Tensor));
- let output = output.as_tensor().as_array_dyn::<f32>();
+ let output = output.as_tensor();
 
  println!("Output tensor computed: {:?}", output);
- assert_eq!(output, array![2.0].into_dyn());
+ assert_eq!(array![2.0_f32], output.as_array());
 }
diff --git a/executorch-sys/Cargo.toml b/executorch-sys/Cargo.toml
@@ -1,11 +1,38 @@
 [package]
 name = "executorch-sys"
-version = "0.1.0"
+version = "0.1.0-rc.1"
+authors = ["Barak Ugav <barakugav@gmail.com>"]
 edition = "2021"
+description = "Unsafe Rust bindings for ExecuTorch - On-device AI across mobile, embedded and edge for PyTorch"
+readme = "README.md"
+repository = "https://github.com/barakugav/executorch-rs"
+license = "Apache-2.0"
+keywords = [
+ "executorch",
+ "pytorch",
+ "ai",
+ "ml",
+ "machine-learning",
+ "mobile",
+ "embedded",
+ "edge-device",
+ "bindings",
+]
+categories = [
+ "algorithms",
+ "mathematics",
+ "embedded",
+ "no-std",
+ "no-std::no-alloc",
+]
+links = "executorch"
+
+[package.metadata.docs.rs]
+features = ["data-loader", "module"]
 
 [features]
-extension-data-loader = []
-extension-module = []
+data-loader = []
+module = []
 
 [dependencies]