Json

ConfigSpace.read_and_write.json

read

read(
    jason_string: str,
    decoders: (
        Mapping[
            Literal[
                "hyperparameters",
                "conditions",
                "forbiddens",
            ],
            Mapping[str, _Decoder],
        ]
        | None
    ) = None,
) -> ConfigurationSpace

Create a configuration space definition from a json string.

from ConfigSpace import ConfigurationSpace
from ConfigSpace.read_and_write import json as cs_json

cs = ConfigurationSpace({"a": [1, 2, 3]})

cs_string = cs_json.write(cs)
with open('configspace.json', 'w') as f:
     f.write(cs_string)

with open('configspace.json', 'r') as f:
    json_string = f.read()
    config = cs_json.read(json_string)

PARAMETER	DESCRIPTION
jason_string	A json string representing a configuration space definition TYPE: str

RETURNS	DESCRIPTION
ConfigurationSpace	The deserialized ConfigurationSpace object

Source code in src/ConfigSpace/read_and_write/json.py

@deprecated(
    "Please use `space.from_json(path)` instead. If you already have the"
    " json string, pass it as `space.from_json(StringIO(jsn))`.",
)
def read(
    jason_string: str,
    decoders: Mapping[
        Literal["hyperparameters", "conditions", "forbiddens"],
        Mapping[str, _Decoder],
    ]
    | None = None,
) -> ConfigurationSpace:
    """Create a configuration space definition from a json string.

    ```python
    from ConfigSpace import ConfigurationSpace
    from ConfigSpace.read_and_write import json as cs_json

    cs = ConfigurationSpace({"a": [1, 2, 3]})

    cs_string = cs_json.write(cs)
    with open('configspace.json', 'w') as f:
         f.write(cs_string)

    with open('configspace.json', 'r') as f:
        json_string = f.read()
        config = cs_json.read(json_string)
    ```


    Args:
        jason_string: A json string representing a configuration space definition

    Returns:
        The deserialized ConfigurationSpace object
    """
    return ConfigurationSpace.from_json(StringIO(jason_string), decoders=decoders)

write

write(
    space: ConfigurationSpace,
    indent: int = 2,
    encoders: (
        Mapping[type, tuple[str, _Encoder]] | None
    ) = None,
) -> str

Create a string representation of a ConfigurationSpace in json format. This string can be written to file.

from ConfigSpace import ConfigurationSpace
from ConfigSpace.read_and_write import json as cs_json

cs = ConfigurationSpace({"a": [1, 2, 3]})

with open('configspace.json', 'w') as f:
    f.write(cs_json.write(cs))

PARAMETER	DESCRIPTION
space	A configuration space, which should be written to file. TYPE: ConfigurationSpace
indent	number of whitespaces to use as indent TYPE: int DEFAULT: 2
encoders	Additional encoders to include where they key is a type to which the encoder applies to and the value is a tuple, where the first element is the type name to include in the dictionary and the second element is the encoder function which gives back a serializable dictionary. TYPE: Mapping[type, tuple[str, _Encoder]] | None DEFAULT: None

RETURNS	DESCRIPTION
str	String representation of the configuration space, which can be written to file

Source code in src/ConfigSpace/read_and_write/json.py

@deprecated(
    "Please use `space.to_json(path)` directly instead. If you require the json string "
    " directly, pass a `StringIO` object to `space.to_json(buffer)`.",
)
def write(
    space: ConfigurationSpace,
    indent: int = 2,
    encoders: Mapping[type, tuple[str, _Encoder]] | None = None,
) -> str:
    """Create a string representation of a
    [ConfigurationSpace][ConfigSpace.configuration_space.ConfigurationSpace] in json format.
    This string can be written to file.

    ```python
    from ConfigSpace import ConfigurationSpace
    from ConfigSpace.read_and_write import json as cs_json

    cs = ConfigurationSpace({"a": [1, 2, 3]})

    with open('configspace.json', 'w') as f:
        f.write(cs_json.write(cs))
    ```

    Args:
        space: A configuration space, which should be written to file.
        indent: number of whitespaces to use as indent
        encoders:
            Additional encoders to include where they key is a type to which the encoder
            applies to and the value is a tuple, where the first element is the type name
            to include in the dictionary and the second element is the encoder function
            which gives back a serializable dictionary.

    Returns:
        String representation of the configuration space, which can be written to file
    """
    buffer = StringIO()
    with buffer as f:
        space.to_json(f, indent=indent, encoders=encoders)
        return f.getvalue()