Skip to content

Commit 4eaa1e4

Browse files
committed
Use proper ordered lists in docstrings
Lists were already formatted as bullet lists with extraneous numbering or as manual plaintext lists.
1 parent 170e975 commit 4eaa1e4

File tree

2 files changed

+42
-42
lines changed

2 files changed

+42
-42
lines changed

src/hyperparam/one_dimensional_range_methods.jl

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -66,31 +66,31 @@ In the first case iteration is over all `values` stored in the range
6666
iteration is over approximately `n` ordered values, generated as
6767
follows:
6868
69-
(i) First, exactly `n` values are generated between `U` and `L`, with a
70-
spacing determined by `r.scale` (uniform if `scale=:linear`) where `U`
71-
and `L` are given by the following table:
72-
73-
| `r.lower` | `r.upper` | `L` | `U` |
74-
|-------------|------------|---------------------|---------------------|
75-
| finite | finite | `r.lower` | `r.upper` |
76-
| `-Inf` | finite | `r.upper - 2r.unit` | `r.upper` |
77-
| finite | `Inf` | `r.lower` | `r.lower + 2r.unit` |
78-
| `-Inf` | `Inf` | `r.origin - r.unit` | `r.origin + r.unit` |
79-
80-
(ii) If a callable `f` is provided as `scale`, then a uniform spacing
81-
is always applied in (i) but `f` is broadcast over the results. (Unlike
82-
ordinary scales, this alters the effective range of values generated,
83-
instead of just altering the spacing.)
84-
85-
(iii) If `r` is a discrete numeric range (`r isa NumericRange{<:Integer}`)
86-
then the values are additionally rounded, with any duplicate values
87-
removed. Otherwise all the values are used (and there are exacltly `n`
88-
of them).
89-
90-
(iv) Finally, if a random number generator `rng` is specified, then the values are
91-
returned in random order (sampling without replacement), and otherwise
92-
they are returned in numeric order, or in the order provided to the
93-
range constructor, in the case of a `NominalRange`.
69+
1. First, exactly `n` values are generated between `U` and `L`, with a
70+
spacing determined by `r.scale` (uniform if `scale=:linear`) where `U`
71+
and `L` are given by the following table:
72+
73+
| `r.lower` | `r.upper` | `L` | `U` |
74+
|-------------|------------|---------------------|---------------------|
75+
| finite | finite | `r.lower` | `r.upper` |
76+
| `-Inf` | finite | `r.upper - 2r.unit` | `r.upper` |
77+
| finite | `Inf` | `r.lower` | `r.lower + 2r.unit` |
78+
| `-Inf` | `Inf` | `r.origin - r.unit` | `r.origin + r.unit` |
79+
80+
2. If a callable `f` is provided as `scale`, then a uniform spacing
81+
is always applied in (1) but `f` is broadcast over the results. (Unlike
82+
ordinary scales, this alters the effective range of values generated,
83+
instead of just altering the spacing.)
84+
85+
3. If `r` is a discrete numeric range (`r isa NumericRange{<:Integer}`)
86+
then the values are additionally rounded, with any duplicate values
87+
removed. Otherwise all the values are used (and there are exacltly `n`
88+
of them).
89+
90+
4. Finally, if a random number generator `rng` is specified, then the values are
91+
returned in random order (sampling without replacement), and otherwise
92+
they are returned in numeric order, or in the order provided to the
93+
range constructor, in the case of a `NominalRange`.
9494
9595
"""
9696
iterator(rng::AbstractRNG, r::ParamRange, args...) =

src/machines.jl

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -572,31 +572,31 @@ the true model given by `getproperty(composite, model)`. See also [`machine`](@r
572572
For the action to be a no-operation, either `mach.frozen == true` or
573573
or none of the following apply:
574574
575-
- (i) `mach` has never been trained (`mach.state == 0`).
575+
1. `mach` has never been trained (`mach.state == 0`).
576576
577-
- (ii) `force == true`.
577+
2. `force == true`.
578578
579-
- (iii) The `state` of some other machine on which `mach` depends has
580-
changed since the last time `mach` was trained (ie, the last time
581-
`mach.state` was last incremented).
579+
3. The `state` of some other machine on which `mach` depends has
580+
changed since the last time `mach` was trained (ie, the last time
581+
`mach.state` was last incremented).
582582
583-
- (iv) The specified `rows` have changed since the last retraining and
584-
`mach.model` does not have `Static` type.
583+
4. The specified `rows` have changed since the last retraining and
584+
`mach.model` does not have `Static` type.
585585
586-
- (v) `mach.model` is a model and different from the last model used for training, but has
587-
the same type.
586+
5. `mach.model` is a model and different from the last model used for training, but has
587+
the same type.
588588
589-
- (vi) `mach.model` is a model but has a type different from the last model used for
590-
training.
589+
6. `mach.model` is a model but has a type different from the last model used for
590+
training.
591591
592-
- (vii) `mach.model` is a symbol and `(composite, mach.model)` is different from the last
593-
model used for training, but has the same type.
592+
7. `mach.model` is a symbol and `(composite, mach.model)` is different from the last
593+
model used for training, but has the same type.
594594
595-
- (viii) `mach.model` is a symbol and `(composite, mach.model)` has a different type from
596-
the last model used for training.
595+
8. `mach.model` is a symbol and `(composite, mach.model)` has a different type from
596+
the last model used for training.
597597
598-
In any of the cases (i) - (iv), (vi), or (viii), `mach` is trained ab initio. If (v) or
599-
(vii) is true, then a training update is applied.
598+
In any of the cases (1) - (4), (6), or (8), `mach` is trained ab initio.
599+
If (5) or (7) is true, then a training update is applied.
600600
601601
To freeze or unfreeze `mach`, use `freeze!(mach)` or `thaw!(mach)`.
602602

0 commit comments

Comments
 (0)