Skip to content

defaultconfig.py


See configuration for a list of available configuration settings.

PyCMTensor config module

Config()

Config class object that holds configuration settings

Attributes:

Name Type Description
descriptions dict

descriptive documentation of each configuration setting

Tip

To display a current list of configuration settings, invoke print(pycmtensor.config).

import pycmtensor
print(pycmtensor.config)

Output:

PyCMTensor configuration
...

add(name, value, description=None)

Method to add a new or update a setting in the configuration

Parameters:

Name Type Description Default
name str

the name of the parameter

required
value any

the value of the parameter

required
description str

description of the parameter

None

Example

To set the value of the random seed to 100

pycmtensor.config.add('seed', 100, description='seed value')

update(name, value, *args, **kwargs)

update the config parameter

Parameters:

Name Type Description Default
name str

the name of the parameter

required
value any

the value of the parameter

required
*args None

overloaded arguments

()
**kwargs dict

overloaded keyword arguments

{}