Skip to content

Commit

Permalink
Document pickle_callables flag
Browse files Browse the repository at this point in the history
  • Loading branch information
nchristensen committed Dec 16, 2022
1 parent 1569e10 commit 1a89bea
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions ConfigSpace/read_and_write/json.py
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,12 @@ def write(configuration_space, indent=2, pickle_callables=False):
a configuration space, which should be written to file.
indent : int
number of whitespaces to use as indent
pickle_callables : bool
whether the writer should attempt to pickle and encode ForbiddenCallableRelations
and similar objects in the configuration space. Defaults to False.
If False, the writer will raise an exception if it encounters a callable
based configuration space object. Unpicklability cannot be assured. Setting
this to True may compromise portability.
Returns
-------
Expand Down

0 comments on commit 1a89bea

Please sign in to comment.