Skip to content

Commit

Permalink
added runtime disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
FlyingWorkshop committed Jan 6, 2025
1 parent cbd71fc commit 41e58f2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/epca.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Fits the EPCA model on the dataset `X`. Call this function after creating an EPC
Should be called after creating an EPCA object or when you want to fit on new data.
!!! warning
The default `fit!` may have long run times depending on the dataset size and model complexity. Consider adjusting the verbosity (`verbose`) and number of iterations (`maxiter`) to better balance runtime and model performance.
# Arguments
- `epca::EPCA`: The EPCA model.
- `X::AbstractMatrix{T}`: (`n`, `indim`) - The input training data matrix. Rows are observations. Columns are features or variables.
Expand Down

0 comments on commit 41e58f2

Please sign in to comment.