Skip to content

Commit 143f97a

Browse files
committed
docstring tweaks around parameter updates
1 parent 05c466b commit 143f97a

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/src/fit_update.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ clustering algorithms); there is no training data and heavy lifting is carried o
1515
### Updating
1616

1717
```
18-
update(model, data; verbosity=..., param1=new_value1, param2=new_value2, ...) -> updated_model
19-
update_observations(model, new_data; verbosity=..., param1=new_value1, ...) -> updated_model
20-
update_features(model, new_data; verbosity=..., param1=new_value1, ...) -> updated_model
18+
update(model, data; verbosity=..., :param1=new_value1, :param2=new_value2, ...) -> updated_model
19+
update_observations(model, new_data; verbosity=..., :param1=new_value1, ...) -> updated_model
20+
update_features(model, new_data; verbosity=..., :param1=new_value1, ...) -> updated_model
2121
```
2222

2323
## Typical workflows

src/fit_update.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ function fit end
6161
update(model, data, param_replacements...; verbosity=1)
6262
6363
Return an updated version of the `model` object returned by a previous [`fit`](@ref) or
64-
`update` call, but with the specified hyperparameter replacements, in the form `p1 =>
65-
value1, p2 => value2, ...`.
64+
`update` call, but with the specified hyperparameter replacements, in the form `:p1 =>
65+
value1, :p2 => value2, ...`.
6666
6767
```julia
6868
learner = MyForest(ntrees=100)
@@ -105,7 +105,7 @@ function update end
105105
106106
Return an updated version of the `model` object returned by a previous [`fit`](@ref) or
107107
`update` call given the new observations present in `new_data`. One may additionally
108-
specify hyperparameter replacements in the form `p1 => value1, p2 => value2, ...`.
108+
specify hyperparameter replacements in the form `:p1 => value1, :p2 => value2, ...`.
109109
110110
```julia-repl
111111
learner = MyNeuralNetwork(epochs=10, learning_rate => 0.01)
@@ -145,7 +145,7 @@ function update_observations end
145145
146146
Return an updated version of the `model` object returned by a previous [`fit`](@ref) or
147147
`update` call given the new features encapsulated in `new_data`. One may additionally
148-
specify hyperparameter replacements in the form `p1 => value1, p2 => value2, ...`.
148+
specify hyperparameter replacements in the form `:p1 => value1, :p2 => value2, ...`.
149149
150150
When following the call `fit(learner, data)`, the `update` call is semantically
151151
equivalent to retraining ab initio using a concatenation of `data` and `new_data`,

0 commit comments

Comments
 (0)