Clean up cargo descriptions and formatting (tracel-ai#403)

yssource · Jun 15, 2023 · 834c7ec · 834c7ec
1 parent 71d7ebb
commit 834c7ec
Show file tree

Hide file tree

Showing 20 changed files with 106 additions and 123 deletions.
diff --git a/burn-autodiff/Cargo.toml b/burn-autodiff/Cargo.toml
@@ -1,10 +1,10 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science"]
-description = "Autodiff backend for burn"
+description = "Automatic differentiation backend for the Burn framework"
 edition = "2021"
 keywords = ["deep-learning", "machine-learning", "data"]
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn-autodiff"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-autodiff"
@@ -15,8 +15,8 @@ default = ["export_tests"]
 export_tests = ["burn-tensor-testgen"]
 
 [dependencies]
-burn-common = {path = "../burn-common", version = "0.8.0" }
-burn-tensor = {path = "../burn-tensor", version = "0.8.0" }
+burn-common = {path = "../burn-common", version = "0.8.0"}
+burn-tensor = {path = "../burn-tensor", version = "0.8.0"}
 burn-tensor-testgen = {path = "../burn-tensor-testgen", version = "0.8.0", optional = true}
 
 derive-new = {workspace = true}

diff --git a/burn-common/Cargo.toml b/burn-common/Cargo.toml
@@ -1,11 +1,11 @@
 [package]
 authors = ["Dilshod Tadjibaev (@antimora)"]
+categories = []
+description = "Common crate for the Burn framework"
 edition = "2021"
-license = "MIT/Apache-2.0"
-name = "burn-common"
-description = "Burn common crate."
 keywords = []
-categories = []
+license = "MIT OR Apache-2.0"
+name = "burn-common"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-common"
 version = "0.8.0"

diff --git a/burn-core/Cargo.toml b/burn-core/Cargo.toml
@@ -1,14 +1,13 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science", "no-std", "embedded", "wasm"]
-description = "BURN: Burn Unstoppable Rusty Neurons"
+description = "Flexible and Comprehensive Deep Learning Framework in Rust"
 edition = "2021"
 keywords = ["deep-learning", "machine-learning", "tensor", "pytorch", "ndarray"]
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn-core"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-core"
-
 version = "0.8.0"
 
 [features]
@@ -31,9 +30,8 @@ std = [
 ]
 
 # Serialization formats
-test-tch = [] # To use tch during testing, default uses ndarray.
 experimental-named-tensor = ["burn-tensor/experimental-named-tensor"]
-
+test-tch = [] # To use tch during testing, default uses ndarray.
 
 [dependencies]
 
@@ -42,7 +40,7 @@ experimental-named-tensor = ["burn-tensor/experimental-named-tensor"]
 burn-autodiff = {path = "../burn-autodiff", version = "0.8.0", optional = true, features = ["export_tests"]}
 burn-common = {path = "../burn-common", version = "0.8.0", default-features = false}
 burn-dataset = {path = "../burn-dataset", version = "0.8.0", default-features = false, optional = true}
-burn-derive = {path = "../burn-derive", version = "0.8.0" }
+burn-derive = {path = "../burn-derive", version = "0.8.0"}
 burn-tensor = {path = "../burn-tensor", version = "0.8.0", default-features = false}
 
 derive-new = {workspace = true}
@@ -59,15 +57,15 @@ hashbrown = {workspace = true, features = ["serde"]}# no_std compatible
 flate2 = {workspace = true, optional = true}
 serde = {workspace = true, features = ["derive"]}
 
-serde_json = {workspace = true, features = ["alloc"]}#Default enables std 
-rmp-serde = {workspace = true, optional = true}
 bincode = {workspace = true}
 half = {workspace = true}
+rmp-serde = {workspace = true, optional = true}
+serde_json = {workspace = true, features = ["alloc"]}#Default enables std 
 
 [dev-dependencies]
 burn-dataset = {path = "../burn-dataset", version = "0.8.0", features = [
   "fake",
 ]}
 
 burn-ndarray = {path = "../burn-ndarray", version = "0.8.0", default-features = false}
-burn-tch = {path = "../burn-tch", version = "0.8.0" }
+burn-tch = {path = "../burn-tch", version = "0.8.0"}
diff --git a/burn-dataset/Cargo.toml b/burn-dataset/Cargo.toml
@@ -1,13 +1,10 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science"]
-description = """
-This library provides an easy to use dataset API with many manipulations
-to easily create your ML data pipeline.
-"""
+description = "Library with simple dataset APIs for creating ML data pipelines"
 edition = "2021"
 keywords = ["deep-learning", "machine-learning", "data"]
-license = "MIT"
+license = "MIT OR Apache-2.0"
 name = "burn-dataset"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-dataset"

diff --git a/burn-derive/Cargo.toml b/burn-derive/Cargo.toml
@@ -1,12 +1,10 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science"]
-description = """
-Burn derive crate.
-"""
+description = "Derive crate for the Burn framework"
 edition = "2021"
 keywords = []
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn-derive"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-derive"
@@ -16,7 +14,7 @@ version = "0.8.0"
 proc-macro = true
 
 [dependencies]
-proc-macro2  = {workspace = true}
+proc-macro2 = {workspace = true}
 quote = {workspace = true}
 # syn = {workspace = true}
 syn = "1.0.109" # TODO upgrade to 2.0
diff --git a/burn-import/Cargo.toml b/burn-import/Cargo.toml
@@ -1,14 +1,12 @@
 [package]
 authors = [
   "Dilshod Tadjibaev (@antimora)",
-  "Nathaniel Simard (@nathanielsimard)"
+  "Nathaniel Simard (@nathanielsimard)",
 ]
+description = "Library for importing datamodels into the Burn framework"
 edition = "2021"
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn-import"
-description = """
-Burn import crate.
-"""
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-import"
 
@@ -19,15 +17,15 @@ default = ["onnx"]
 onnx = []
 
 [dependencies]
-burn = {path = "../burn", version = "0.8.0" }
-burn-ndarray = {path = "../burn-ndarray", version = "0.8.0" }
-burn-common = {path = "../burn-common", version = "0.8.0" }
+burn = {path = "../burn", version = "0.8.0"}
+burn-common = {path = "../burn-common", version = "0.8.0"}
+burn-ndarray = {path = "../burn-ndarray", version = "0.8.0"}
 
-log = {workspace = true}
-log4rs = { workspace = true }
 bytemuck = {workspace = true}
 derive-new = {workspace = true}
 half = {workspace = true}
+log = {workspace = true}
+log4rs = {workspace = true}
 proc-macro2 = {workspace = true}
 protobuf = {version = "3.2", features = ["with-bytes"]}
 quote = {workspace = true}

diff --git a/burn-ndarray/Cargo.toml b/burn-ndarray/Cargo.toml
@@ -1,10 +1,10 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science", "no-std", "embedded", "wasm"]
-description = "NdArray backend for burn"
+description = "Ndarray backend for the Burn framework"
 edition = "2021"
 keywords = ["deep-learning", "machine-learning", "data"]
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn-ndarray"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-ndarray"
@@ -29,9 +29,9 @@ blas-accelerate = ["ndarray/blas", "blas-src/accelerate"] # Accelerate framework
 blas-netlib = ["ndarray/blas", "blas-src/netlib"]
 blas-openblas = ["ndarray/blas", "blas-src/openblas", "openblas-src"]
 blas-openblas-system = [
-    "ndarray/blas",
-    "blas-src/openblas",
-    "openblas-src/system",
+  "ndarray/blas",
+  "blas-src/openblas",
+  "openblas-src/system",
 ]
 
 [dependencies]
@@ -42,7 +42,6 @@ burn-autodiff = {path = "../burn-autodiff", version = "0.8.0", features = ["expo
 burn-common = {path = "../burn-common", version = "0.8.0", default-features = false}
 burn-tensor = {path = "../burn-tensor", version = "0.8.0", default-features = false, features = ["export_tests"]}
 
-
 matrixmultiply = {version = "0.3.7", default-features = false}
 rayon = {workspace = true, optional = true}
 

diff --git a/burn-no-std-tests/Cargo.toml b/burn-no-std-tests/Cargo.toml
@@ -4,11 +4,10 @@ authors = [
   "Dilshod Tadjibaev (@antimora)",
 ]
 edition = "2021"
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn-no-std-tests"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-no-std-tests"
-
 version = "0.8.0"
 
 [dependencies]

diff --git a/burn-tch/Cargo.toml b/burn-tch/Cargo.toml
@@ -1,10 +1,10 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science"]
-description = "Tch backend for burn"
+description = "Tch backend for the Burn framework"
 edition = "2021"
 keywords = ["deep-learning", "machine-learning", "data"]
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn-tch"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-tch"

diff --git a/burn-tensor-testgen/Cargo.toml b/burn-tensor-testgen/Cargo.toml
@@ -1,17 +1,17 @@
 [package]
-name = "burn-tensor-testgen"
-version = "0.8.0"
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
-description = "Burn tensor test gen crate."
-repository = "https://github.com/burn-rs/burn/tree/main/burn-tensor-testgen"
-readme = "README.md"
-license = "MIT/Apache-2.0"
+description = "Test generation crate for burn-tensor"
 edition = "2021"
+license = "MIT OR Apache-2.0"
+name = "burn-tensor-testgen"
+readme = "README.md"
+repository = "https://github.com/burn-rs/burn/tree/main/burn-tensor-testgen"
+version = "0.8.0"
 
 [lib]
 proc-macro = true
 
 [dependencies]
-syn = {workspace = true}
-quote = {workspace = true}
 proc-macro2 = {workspace = true}
+quote = {workspace = true}
+syn = {workspace = true}
diff --git a/burn-tensor/Cargo.toml b/burn-tensor/Cargo.toml
@@ -1,13 +1,10 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science", "no-std", "embedded", "wasm"]
-description = """
-This library provides multiple tensor implementations hidden behind
-an easy to use API that supports reverse mode automatic differentiation.
-"""
+description = "Tensor library with user-friendly APIs and automatic differentiation support"
 edition = "2021"
 keywords = ["deep-learning", "machine-learning", "tensor", "pytorch", "ndarray"]
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn-tensor"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-tensor"

diff --git a/burn-train/Cargo.toml b/burn-train/Cargo.toml
@@ -1,33 +1,32 @@
 [package]
-name = "burn-train"
-version = "0.8.0"
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
-description = "Training crate for burn"
-repository = "https://github.com/burn-rs/burn/tree/main/burn-train"
-
-readme = "README.md"
-keywords = ["deep-learning", "machine-learning", "tensor", "pytorch", "ndarray"]
 categories = ["science"]
-license = "MIT/Apache-2.0"
+description = "Training crate for the Burn framework"
 edition = "2021"
+keywords = ["deep-learning", "machine-learning", "tensor", "pytorch", "ndarray"]
+license = "MIT OR Apache-2.0"
+name = "burn-train"
+readme = "README.md"
+repository = "https://github.com/burn-rs/burn/tree/main/burn-train"
+version = "0.8.0"
 
 [dependencies]
-burn-core = { path = "../burn-core", version = "0.8.0" }
+burn-core = {path = "../burn-core", version = "0.8.0"}
 
 # Console
 indicatif = "0.17.5"
-log4rs = { workspace = true }
-log = { workspace = true }
+log = {workspace = true}
+log4rs = {workspace = true}
 
 # Metrics
 nvml-wrapper = "0.9.0"
-textplots = "0.8.0"
 rgb = "0.8.36"
 terminal_size = "0.2.6"
+textplots = "0.8.0"
 
 # Utilities
-derive-new = { workspace = true }
-serde = { workspace = true, features = ["std", "derive"] }
+derive-new = {workspace = true}
+serde = {workspace = true, features = ["std", "derive"]}
 
 [dev-dependencies]
-burn-ndarray = { path ="../burn-ndarray", version = "0.8.0" }
+burn-ndarray = {path = "../burn-ndarray", version = "0.8.0"}
diff --git a/burn-wgpu/Cargo.toml b/burn-wgpu/Cargo.toml
@@ -1,33 +1,33 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science"]
-description = "WGPU backend for burn"
+description = "WGPU backend for the Burn framework"
 edition = "2021"
-keywords = ["deep-learning", "machine-learning", "data"]
-license = "MIT/Apache-2.0"
+keywords = ["deep-learning", "machine-learning", "gpu", "wgpu", "webgpu"]
+license = "MIT OR Apache-2.0"
 name = "burn-wgpu"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn/tree/main/burn-wgpu"
 version = "0.8.0"
 
 [features]
-default = ["async"]
 async = []
+default = ["async"]
 
 [dependencies]
-burn-tensor = {path = "../burn-tensor", version = "0.8.0"}
 burn-common = {path = "../burn-common", version = "0.8.0"}
-derive-new = {workspace = true}
+burn-tensor = {path = "../burn-tensor", version = "0.8.0"}
 bytemuck = {workspace = true}
-rand = {workspace = true}
+derive-new = {workspace = true}
+log = {workspace = true}
 num-traits = {workspace = true}
+rand = {workspace = true}
 spin = {workspace = true}
-log = {workspace = true}
 
 # WGPU stuff
-wgpu = {workspace = true}
 futures-intrusive = {workspace = true}
 pollster = {workspace = true}
+wgpu = {workspace = true}
 
 [dev-dependencies]
 burn-autodiff = {path = "../burn-autodiff", version = "0.8.0", default-features = false, features = [

diff --git a/burn/Cargo.toml b/burn/Cargo.toml
@@ -1,22 +1,21 @@
 [package]
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 categories = ["science", "no-std", "embedded", "wasm"]
-description = "BURN: Burn Unstoppable Rusty Neurons"
+description = "Flexible and Comprehensive Deep Learning Framework in Rust"
 edition = "2021"
 keywords = ["deep-learning", "machine-learning", "tensor", "pytorch", "ndarray"]
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "burn"
 readme = "README.md"
 repository = "https://github.com/burn-rs/burn"
-
 version = "0.8.0"
 
 [features]
 default = ["std", "train"]
+experimental-named-tensor = ["burn-core/experimental-named-tensor"]
 std = [
   "burn-core/std",
 ]
-experimental-named-tensor = ["burn-core/experimental-named-tensor"]
 train = ["std", "burn-train"] # Training requires std
 
 [dependencies]