Skip to content

Commit 1a89bea

Browse files
committed
Document pickle_callables flag
1 parent 1569e10 commit 1a89bea

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

ConfigSpace/read_and_write/json.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,12 @@ def write(configuration_space, indent=2, pickle_callables=False):
348348
a configuration space, which should be written to file.
349349
indent : int
350350
number of whitespaces to use as indent
351+
pickle_callables : bool
352+
whether the writer should attempt to pickle and encode ForbiddenCallableRelations
353+
and similar objects in the configuration space. Defaults to False.
354+
If False, the writer will raise an exception if it encounters a callable
355+
based configuration space object. Unpicklability cannot be assured. Setting
356+
this to True may compromise portability.
351357
352358
Returns
353359
-------

0 commit comments

Comments
 (0)