coreylowman · coreylowman · Feb 22, 2023 · Feb 22, 2023 · Feb 22, 2023
diff --git a/build.rs b/build.rs
@@ -39,6 +39,7 @@ mod cuda {
         println!("cargo:warning=Found kernels {kernel_paths:?}");
         println!("cargo:warning=Found include directories {include_directories:?}");
 
+        #[allow(unused)]
         let include_options: Vec<String> = include_directories
             .into_iter()
             .map(|s| "-I".to_string() + &s.into_os_string().into_string().unwrap())

diff --git a/src/data/batch.rs b/src/data/batch.rs
@@ -33,7 +33,7 @@ impl<I: Iterator> Iterator for Batcher<usize, I> {
 /// Create batches of items from an [Iterator]
 pub trait IteratorBatchExt: Iterator {
     /// Return an [Iterator] where the items are either:
-    /// - `[Self::Item; N]`, if `Size` is [Const<N>]
+    /// - `[Self::Item; N]`, if `Size` is [`Const<N>`]
     /// - `Vec<Self::Item>`, if `Size` is [usize].
     ///
     /// **Drop last is not supported - always returns exact batches**

diff --git a/src/data/one_hot_encode.rs b/src/data/one_hot_encode.rs
@@ -12,7 +12,7 @@ pub trait OneHotEncode<E: Dtype>: DeviceStorage + ZerosTensor<E> + CopySlice<E>
     ///
     /// Arguments:
     /// - `n` - the numnber of classes to use to encode, can be `Const` or `usize`
-    /// - `class_labels` - either an array [usize; N], or Vec<usize>
+    /// - `class_labels` - either an array `[usize; N]`, or `Vec<usize>`
     ///
     /// Const class labels and const n:
     /// ```rust

diff --git a/src/gradients.rs b/src/gradients.rs
@@ -14,13 +14,6 @@ use crate::unique_id::{HasUniqueId, UniqueId};
 /// 2. Remove entries
 /// 3. Access references to arrays
 /// 4. Access mutable references to arrays
-///
-/// This structure is similar to a HashMap, where all the methods require a key
-/// implementing [UniqueId], [AllocGrad].
-///
-/// Under the hood, it actually is a HashMap, and stores values as Box<dyn Any>. The
-/// important part of key's implementing [HasShape], and [HasDtype] is that the associated type
-/// of that trait is used to downcast the box to the expected value.
 #[derive(Debug, Default)]
 pub struct Gradients {
     gradient_by_id: HashMap<UniqueId, Box<dyn std::any::Any>>,

diff --git a/src/nn/tensor_collection/collection.rs b/src/nn/tensor_collection/collection.rs
@@ -55,7 +55,7 @@ impl<S: Shape, E: Dtype, D: DeviceStorage> TensorCollection<E, D> for Tensor<S,
     }
 }
 
-/// Options to change behavior of [TensorVisitor]
+/// Options to change behavior of [ModuleVisitor]
 #[non_exhaustive]
 pub struct TensorOptions<S: Shape, E: Dtype, D: DeviceStorage> {
     /// Whether the tensor should be updated with gradients

diff --git a/src/nn/tensor_collection/visitor.rs b/src/nn/tensor_collection/visitor.rs
@@ -18,7 +18,7 @@ pub struct RecursiveWalker<'a, M, F> {
 
 /// Something that can visit [Tensor]s. Used in conjunction with [RecursiveWalker].
 pub trait TensorVisitor<E: Dtype, D: DeviceStorage> {
-    /// The type of tensor this struct uses. E.g. [TensorMut], or [TensorRef]
+    /// The type of tensor this struct uses. E.g. [ViewTensorMut], or [ViewTensorRef]
     type Viewer: TensorViewer;
     type Err;