New version 1.2.2 (#419)

* New version 1.2.2

* Documentation bugfixes wrt incorrect references

* docs bugfix reference

* Bugfixes for documentation

Author: thijssnelleman

.gitignore

@@ -3,6 +3,7 @@
 # Documentation
 docs/build/*
 docs/examples/*
+site/*
 
 *.py[cod]
 

docs/guide.md

@@ -300,7 +300,7 @@ print(cs)
 ```
 
 To check that your prior makes sense for each hyperparameter,
-you can easily do so with the [`pdf_values()`][ConfigSpace.hyperparameters.Hyperparameter.pdf_values] method.
+you can easily do so with the [`pdf_values()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.pdf_values] method.
 There, you will see that the probability of the optimal learning rate peaks at
 10^-3, and decays as we go further away from it:
 

docs/reference/hyperparameters.md

@@ -244,18 +244,18 @@ What makes a hyperparameter the hyperparameter it is then:
 
 Using just these two components alone, we can provide the following functionality from the [`Hyperparameter`][ConfigSpace.hyperparameters.Hyperparameter] base class:
 
-* [`sample_vector()`][ConfigSpace.hyperparameters.Hyperparameter.sample_vector]: Samples a vectorized value
-* [`sample_value()`][ConfigSpace.hyperparameters.Hyperparameter.sample_value]:
+* [`sample_vector()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.sample_vector]: Samples a vectorized value
+* [`sample_value()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.sample_value]:
 Samples a vectorized value and transforms it back to the value space.
-* [`to_value()`][ConfigSpace.hyperparameters.Hyperparameter.to_value]: Transforms a vectorized value to the value space.
-* [`to_vector()`][ConfigSpace.hyperparameters.Hyperparameter.to_vector]: Transforms a value space value to the vectorized space.
-* [`pdf_vector()`][ConfigSpace.hyperparameters.Hyperparameter.pdf_vector]: The probability density function of a vectorized value.
-* [`pdf_values()`][ConfigSpace.hyperparameters.Hyperparameter.pdf_values]: The probability density function of a value,
+* [`to_value()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.to_value]: Transforms a vectorized value to the value space.
+* [`to_vector()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.to_vector]: Transforms a value space value to the vectorized space.
+* [`pdf_vector()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.pdf_vector]: The probability density function of a vectorized value.
+* [`pdf_values()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.pdf_values]: The probability density function of a value,
   by transforming it to the vectorized space and then calculating the pdf.
-* [`legal_value()`][ConfigSpace.hyperparameters.Hyperparameter.legal_value]: Check if a value is legal.
-* [`legal_vector()`][ConfigSpace.hyperparameters.Hyperparameter.legal_vector]: Check if a vectorized value is legal.
-* [`.lower_vectorized`][ConfigSpace.hyperparameters.Hyperparameter.lower_vectorized]: The lower bound in vectorized space.
-* [`.upper_vectorized`][ConfigSpace.hyperparameters.Hyperparameter.upper_vectorized]: The upper bound in vectorized space.
+* [`legal_value()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.legal_value]: Check if a value is legal.
+* [`legal_vector()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.legal_vector]: Check if a vectorized value is legal.
+* [`.lower_vectorized`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.lower_vectorized]: The lower bound in vectorized space.
+* [`.upper_vectorized`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.upper_vectorized]: The upper bound in vectorized space.
 
 
 Please note that most of these methods support individual values or numpy arrays of values, either as input or output.
@@ -288,10 +288,10 @@ unbounded or a method that returns the maximum possible neighbors that are possi
 
 By subclasses providing this through the `__init__` method, we can then provide the following functionality:
 
-* [`get_num_neighbors()`][ConfigSpace.hyperparameters.Hyperparameter.get_num_neighbors]: Get the number of neighbours around a value.
-* [`neighbors_vectorized()`][ConfigSpace.hyperparameters.Hyperparameter.neighbors_vectorized]: Get neighbors around a
+* [`get_num_neighbors()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.get_num_neighbors]: Get the number of neighbours around a value.
+* [`neighbors_vectorized()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.neighbors_vectorized]: Get neighbors around a
 point in vectorized space.
-* [`neighbors_values()`][ConfigSpace.hyperparameters.Hyperparameter.neighbors_values]: Get neighbors around a
+* [`neighbors_values()`][ConfigSpace.hyperparameters.hyperparameter.Hyperparameter.neighbors_values]: Get neighbors around a
 point in value space.
 
 Please refer to the source code definition of existing hyperparameters for more information on how to implement this.

mkdocs.yml

@@ -133,14 +133,6 @@ plugins:
       handlers:
         python:
           paths: [src]
-          # Extra objects which allow for linking to external docs
-          import:
-            - 'https://docs.python.org/3/objects.inv'
-            - 'https://numpy.org/doc/stable/objects.inv'
-            - 'https://scikit-learn.org/stable/objects.inv'
-          # Please do not try to change these without having
-          # looked at all of the documentation and seeing if it
-          # causes the API docs to look weird anywhere.
           options:  # https://mkdocstrings.github.io/python/usage/
             docstring_section_style: spacy
             docstring_options:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ConfigSpace"
-version = "1.2.1"
+version = "1.2.2"
 description = """\
     Creation and manipulation of parameter configuration spaces for \
     automated algorithm configuration and hyperparameter tuning. \
@@ -20,6 +20,7 @@ authors = [
   { name = "Jorn Tuyls" },
   { name = "Eddie Bergman" },
   { name = "Arjun Krishnakumar" },
+  { name = "Thijs Snelleman" },
 ]
 maintainers = [
   { name = "Matthias Feurer", email = "feurerm@informatik.uni-freiburg.de" },

src/ConfigSpace/configuration.py

@@ -19,13 +19,13 @@
 class Configuration(Mapping[str, Any]):
     """Class for a single configuration.
 
-    The [`Configuration`][ConfigSpace.configuration_space.Configuration] object
+    The [`Configuration`][ConfigSpace.configuration.Configuration] object
     holds for all active hyperparameters a value. While the
     [`ConfigurationSpace`][ConfigSpace.configuration_space.ConfigurationSpace]
     stores the definitions for the hyperparameters (value ranges, constraints,...),
-    a [`Configuration`][ConfigSpace.configuration_space.Configuration] object is
+    a [`Configuration`][ConfigSpace.configuration.Configuration] object is
     more an instance of it. Parameters of a
-    [`Configuration`][ConfigSpace.configuration_space.Configuration] object can be
+    [`Configuration`][ConfigSpace.configuration.Configuration] object can be
     accessed and modified similar to python dictionaries
     (c.f. [user guilde](../../guide.md)).
     """

src/ConfigSpace/exceptions.py

@@ -10,8 +10,9 @@
 class ForbiddenValueError(ValueError):
     """Raised when a combination of values is forbidden for a Configuration."""
 
-
 class IllegalValueError(ValueError):
+    """Raised when a value is illegal for a Hyperparameter."""
+
     def __init__(self, hyperparameter: Hyperparameter, value: Any):
         super().__init__()
         self.hyperparameter = hyperparameter
@@ -26,6 +27,8 @@ def __str__(self) -> str:
 
 
 class IllegalVectorizedValueError(ValueError):
+    """Raised when a vectorized value is illegal for a Hyperparameter."""
+
     def __init__(self, hyperparameter: Hyperparameter, vector: Any):
         super().__init__()
         self.hyperparameter = hyperparameter
@@ -40,6 +43,8 @@ def __str__(self) -> str:
 
 
 class ActiveHyperparameterNotSetError(ValueError):
+    """Raised when a Hyperparameter is active but has no value set."""
+
     def __init__(self, hyperparameter: Hyperparameter) -> None:
         super().__init__(hyperparameter)
         self.hyperparameter = hyperparameter
@@ -49,6 +54,8 @@ def __str__(self) -> str:
 
 
 class InactiveHyperparameterSetError(ValueError):
+    """Raised when a Hyperparameter is inactive but has a value set."""
+
     def __init__(self, hyperparameter: Hyperparameter, value: Any) -> None:
         super().__init__(hyperparameter)
         self.hyperparameter = hyperparameter