Skip to content

Commit

Permalink
docs: add mod titles
Browse files Browse the repository at this point in the history
  • Loading branch information
drewxs committed Sep 3, 2023
1 parent 9e91d0e commit 2497b39
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 3 deletions.
2 changes: 2 additions & 0 deletions src/initializer.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Initializations for weight matrices.

use rand::Rng;

use crate::tensor::Tensor2D;
Expand Down
2 changes: 2 additions & 0 deletions src/logistic_regression.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Logistic regression model.

use rand::Rng;

pub struct LogisticRegression {
Expand Down
2 changes: 2 additions & 0 deletions src/loss.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Loss functions.

use crate::Tensor;

/// Mean squared error loss.
Expand Down
2 changes: 1 addition & 1 deletion src/optimizer.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Implements different optimizers to be used with neural networks.
//! Optimization algorithms.
//!
//! Use to minimize the loss function during the training process of a neural network by
//! adjusting the weights of the network based on the gradients of the loss function with
Expand Down
4 changes: 4 additions & 0 deletions src/prelude.rs
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
//! Engram prelude.
//!
//! Contains all the most commonly used types and functions.

pub use crate::{tensor, Activation, Initializer, Network, Optimizer, Tensor};
3 changes: 2 additions & 1 deletion src/regularization.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
//! This module provides implementations for L1 and L2 regularization.
//! L1/L2 regularization.
//!
//! Regularization can be used to prevent overfitting.
//!
//! # Example
Expand Down
2 changes: 1 addition & 1 deletion src/stats.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! This module contains functions for calculating statistics.
//! Statistics.

use std::{
collections::HashMap,
Expand Down

0 comments on commit 2497b39

Please sign in to comment.