Add docs to the Tensor struct (tracel-ai#31)

djdisodo · Sep 9, 2022 · d0b581a · d0b581a
1 parent 823f28c
commit d0b581a
Show file tree

Hide file tree

Showing 6 changed files with 286 additions and 54 deletions.
diff --git a/.github/workflows/test-burn-dataset.yml b/.github/workflows/test-burn-dataset.yml
@@ -23,7 +23,12 @@ jobs:
           cd burn-dataset
           cargo fmt --check --all
 
+      - name: check doc
+        run: |
+          cd burn-dataset
+          cargo test --doc
+
       - name: check tests
         run: |
           cd burn-dataset
-          cargo test
+          cargo test --tests
diff --git a/.github/workflows/test-burn-tensor.yml b/.github/workflows/test-burn-tensor.yml
@@ -23,14 +23,19 @@ jobs:
           cd burn-tensor
           cargo fmt --check --all
 
+      - name: check doc
+        run: |
+          cd burn-tensor
+          cargo test --no-default-features --features doc --doc
+
       - name: check tests backend ndarray
         run: |
           cd burn-tensor
-          cargo test --no-default-features --features ndarray
+          cargo test --no-default-features --features ndarray --tests
 
       - name: check tests backend tch
         run: |
           cd burn-tensor
-          cargo test --no-default-features --features tch
+          cargo test --no-default-features --features tch --tests
 
 
diff --git a/.github/workflows/test-burn.yml b/.github/workflows/test-burn.yml
@@ -23,7 +23,13 @@ jobs:
           cd burn
           cargo fmt --check --all
 
+
+      - name: check doc
+        run: |
+          cd burn
+          cargo test --no-default-features --features doc --doc
+
       - name: check tests
         run: |
           cd burn
-          cargo test
+          cargo test --tests
diff --git a/burn-tensor/Cargo.toml b/burn-tensor/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "burn-tensor"
-version = "0.2.1"
+version = "0.2.2"
 authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]
 
 description = """
@@ -13,17 +13,18 @@ keywords = ["deep-learning", "machine-learning", "tensor", "pytorch", "ndarray"]
 categories = ["science"]
 license = "MIT/Apache-2.0"
 edition = "2021"
+doctest = false
 
 [package.metadata.docs.rs]
-features = ["ndarray"]
+features = ["doc"]
 all-features = false
 no-default-features = true
 
 [features]
-default = ["ndarray"]
-full = ["tch", "ndarray"]
+default = ["tch", "ndarray"]
 tch = ["dep:tch"]
 ndarray = ["dep:ndarray"]
+doc = ["dep:tch", "tch/doc-only", "dep:ndarray"]
 
 [dependencies]
 num-traits = "0.2"