Add docstring for Dataset

MilesCranmer · Sep 13, 2022 · e45d1ba · e45d1ba
1 parent 8e9cbc6
commit e45d1ba
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/src/types.md b/docs/src/types.md
@@ -64,6 +64,7 @@ HallOfFame(options::Options, ::Type{T}) where {T<:Real}
 ## Dataset
 
 ```@docs
+Dataset{T<:Real}
 Dataset(X::AbstractMatrix{T},
         y::AbstractVector{T};
         weights::Union{AbstractVector{T}, Nothing}=nothing,

diff --git a/src/Dataset.jl b/src/Dataset.jl
@@ -2,6 +2,21 @@ module DatasetModule
 
 import ..ProgramConstantsModule: BATCH_DIM, FEATURE_DIM
 
+"""
+    Dataset{T<:Real}
+
+# Fields
+
+- `X::AbstractMatrix{T}`: The input features, with shape `(nfeatures, n)`.
+- `y::AbstractVector{T}`: The desired output values, with shape `(n,)`.
+- `n::Int`: The number of samples.
+- `nfeatures::Int`: The number of features.
+- `weighted::Bool`: Whether the dataset is non-uniformly weighted.
+- `weights::Union{AbstractVector{T},Nothing}`: If the dataset is weighted,
+    these specify the per-sample weight (with shape `(n,)`).
+- `varMap::Array{String,1}`: The names of the features,
+    with shape `(nfeatures,)`.
+"""
 struct Dataset{T<:Real}
     X::AbstractMatrix{T}
     y::AbstractVector{T}