Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-rapp committed Oct 2, 2024
1 parent 844372f commit 1f96b93
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
12 changes: 10 additions & 2 deletions doc/user_guide/boosting/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -405,9 +405,17 @@ The seed to be used by random number generators. The given value must be at leas
`'without-replacement'`
The outputs to be considered when learning a new rule are chosen randomly. The following options may be provided using the {ref}`bracket notation<bracket-notation>`:
- `num_samples` *(Default value = `1`)*
- `sample_size` *(Default value = `0.33`)*
The number of outputs to be included in a sample. The given value must be at least 1.
The percentage of outputs to be included in a sample. For example, a value of 0.6 corresponds to 60% of the outputs. The given value must be in (0, 1\].
- `min_samples` *(Default value = `1`)*
The minimum number of outputs to be included in a sample. The given value must be at least 1.
- `max_samples` *(Default value = `1`)*
The maximum number of outputs to be included in a sample. The given value must be at least the value of `min_samples` or 0, if the number of outputs should not be restricted.
```

(boosting_parameters_feature_sampling)=
Expand Down
12 changes: 10 additions & 2 deletions doc/user_guide/seco/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,9 +335,17 @@ The seed to be used by random number generators. The given value must be at leas
`'without-replacement'`
The outputs to be considered when learning a new rule are chosen randomly. The following options may be provided using the {ref}`bracket notation<bracket-notation>`:
- `num_samples` *(Default value = `1`)*
- `sample_size` *(Default value = `0.33`)*
The number of outputs to be included in a sample. The given value must be at least 1.
The percentage of outputs to be included in a sample. For example, a value of 0.6 corresponds to 60% of the outputs. The given value must be in (0, 1\].
- `min_samples` *(Default value = `1`)*
The minimum number of outputs to be included in a sample. The given value must be at least 1.
- `max_samples` *(Default value = `1`)*
The maximum number of outputs to be included in a sample. The given value must be at least the value of `min_samples` or 0, if the number of outputs should not be restricted.
```

(seco_parameters_feature_sampling)=
Expand Down

0 comments on commit 1f96b93

Please sign in to comment.