Added doc-comments to tensor.rs #12
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akhilles
reviewed
Mar 29, 2024
libs/nox/src/tensor.rs
Outdated
| pub trait MapDim<D> { | ||
| /// The item associated with the dimension mapping. |
There was a problem hiding this comment.
We probably don't need these inner comments.
libs/nox/src/tensor.rs
Outdated
| pub trait DimConcat<A, B> { | ||
| /// The resulting dimension type after concatenation. |
libs/nox/src/tensor.rs
Outdated
| pub trait TensorIndex<T, D: TensorDim> { | ||
| /// The output type resulting from the indexing operation. |
|
The commit message has a typo btw |
nestordemeure
force-pushed
the
documentation
branch
from
ddb5d8a
to
7fb7274
Compare
|
Thanks, I have fixed the commit text and removed inner comments. |
akhilles
reviewed
Mar 31, 2024
libs/nox/src/tensor.rs
Outdated
| @@ -10,6 +11,8 @@ use std::{ | |||
| }; | |||
| use xla::{ArrayElement, ElementType, NativeType}; | |||
|
|
|||
| /// Represents a tensor with a specific type `T`, dimensionality `D`, and parameterization `P`. | |||
There was a problem hiding this comment.
"underlying representation P" is a bit more accurate.
libs/nox/src/tensor.rs
Outdated
| @@ -10,6 +11,8 @@ use std::{ | |||
| }; | |||
| use xla::{ArrayElement, ElementType, NativeType}; | |||
|
|
|||
| /// Represents a tensor with a specific type `T`, dimensionality `D`, and parameterization `P`. | |||
| /// `P` dictates the underlying representation and operations available on the tensor. | |||
There was a problem hiding this comment.
"operations available on the tensor" is not quite accurate. Would just drop this sentence, and change the previous sentence to include the "underlying representation" part.
akhilles
approved these changes
Mar 31, 2024
akhilles
pushed a commit
that referenced
this pull request
Mar 31, 2024
Signed-off-by: Akhil Velagapudi <[email protected]>
akhilles
pushed a commit
that referenced
this pull request
Apr 18, 2024
Signed-off-by: Akhil Velagapudi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following the discussion in issue11, here is a PR adding doc comments to
tensor.rs. This is a first test in introducing AI-generated comments to document the library faster, making it easier to pick up by new users.Here is a preview of what it looks like in conditions (
cargo doc --open --no-deps --all-features):This is a test to think about the viability of this approach. Do feel free to comment and criticize (things can definitely be streamlined by hand, this PR had no manual tweak of the comments so far)!
For archival purposes, here is the prompt used to generate the comments (with GPT-4):