Skip to content

Commit

Permalink
doc: Fix documentation for continuous_neighborhood
Browse files Browse the repository at this point in the history
  • Loading branch information
eddiebergman committed Jul 12, 2024
1 parent de0b36e commit 82d66fd
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions src/ConfigSpace/hyperparameters/distributions.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,20 +212,11 @@ def continuous_neighborhood(
) -> Array[f64]:
"""Create a neighborhood of `n` neighbors around `vector` with a normal distribution.
The neighborhood is created by sampling from a normal distribution centered around
`vector` with a standard deviation of `std`. The samples are then quantized to the
range `[lower, upper]` with `bins` bins. The number of samples is `n`.
!!! warning
If there are not enough unique neighbors to sample from, the function will
return less than `n` neighbors.
Args:
vector: The center of the neighborhood.
n: The number of neighbors to generate.
lower: The lower bound of the quantized range.
upper: The upper bound of the quantized range.
lower: The lower bound of the neighborhood range.
upper: The upper bound of the neighborhood range.
std: The standard deviation of the normal distribution. If `None` will use
[`DEFAULT_VECTORIZED_NUMERIC_STD`][ConfigSpace.hyperparameters.distributions.DEFAULT_VECTORIZED_NUMERIC_STD].
seed: The random seed to use.
Expand Down

0 comments on commit 82d66fd

Please sign in to comment.