Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add docs to the Tensor struct #31

Merged
merged 5 commits into from
Sep 9, 2022
Merged

Add docs to the Tensor struct #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0452053
Add docs to the Tensor struct
nathanielsimard Sep 5, 2022
83d08f0
Complete some docs
nathanielsimard Sep 5, 2022
e154fb6
Fix version
nathanielsimard Sep 5, 2022
00762ee
Fix doc tests
nathanielsimard Sep 9, 2022
41b2d9f
Fix ci
nathanielsimard Sep 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/test-burn-dataset.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
9 changes: 7 additions & 2 deletions .github/workflows/test-burn-tensor.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


8 changes: 7 additions & 1 deletion .github/workflows/test-burn.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
9 changes: 5 additions & 4 deletions burn-tensor/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "burn-tensor"
version = "0.2.1"
version = "0.2.2"
authors = ["nathanielsimard <nathaniel.simard.42@gmail.com>"]

description = """
Expand All @@ -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"
Expand Down
Loading