Skip to content

Commit 226a4fe

Browse files
committed
add activation and ignore_nan docs
1 parent 5af4cee commit 226a4fe

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

src/find_path.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ word, which n-grams are best supported for a given position in the sequence of n
7070
- `sparse_ratio::Float64=0.05`: the ratio to decide whether a matrix is sparse
7171
- `if_pca::Bool=false`: turn on to enable pca mode
7272
- `pca_eval_M::Matrix=nothing`: pass original F for pca mode
73+
- `activation::Function=nothing`: the activation function you want to pass
74+
- `ignore_nan::Bool=true`: whether to ignore NaN when compare correlations, otherwise NaN will be selected as the max correlation value
7375
- `verbose::Bool=false`: if true, more information is printed
7476
7577
# Examples
@@ -482,6 +484,8 @@ for users who is very new to JudiLing and learn_paths function.
482484
- `is_tolerant::Bool=false`: if true, select a specified number (given by `max_tolerance`) of n-grams whose supports are below threshold but above a second tolerance threshold to be added to the path
483485
- `tolerance::Float64=(-1000.0)`: the value set for the second threshold (in tolerant mode) such that if the support for an n-gram is in between this value and the threshold and the max_tolerance number has not been reached, then allow this n-gram to be added to the path
484486
- `max_tolerance::Int64=4`: maximum number of n-grams allowed in a path
487+
- `activation::Function=nothing`: the activation function you want to pass
488+
- `ignore_nan::Bool=true`: whether to ignore NaN when compare correlations, otherwise NaN will be selected as the max correlation value
485489
- `verbose::Bool=false`: if true, more information is printed
486490
487491
# Examples

src/wh.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Widrow-Hoff Learning.
1111
- `n_epochs::Int64=1`: the number of epochs to be trained
1212
- `weights::Matrix=nothing`: the initial weights
1313
- `learn_seq::Vector=nothing`: the learning sequence
14+
- `save_history::Bool=false`: if true, a partical training history will be saved
15+
- `history_cols::Vector=nothing`: the list of column indices you want to saved in history, e.g. `[1,32,42]` or `[2]`
16+
- `history_rows::Vector=nothing`: the list of row indices you want to saved in history, e.g. `[1,32,42]` or `[2]`
1417
- `verbose::Bool = false`: if true, more information will be printed out
1518
"""
1619
function wh_learn(

0 commit comments

Comments
 (0)