orphan: |
---|
To adjust Modin's default behavior, you can set the value of Modin
configs by setting an environment variable or by using the
modin.config
API. To list all available configs in Modin, please
run python -m modin.config
to print all
Modin configs with descriptions.
Potentially, the source of configs can be any, but for now only environment variables are implemented. Any environment variable originate from :class:`~modin.config.envvars.EnvironmentVariable`, which contains most of the config API implementation.
.. autoclass:: modin.config.envvars.EnvironmentVariable :members: get, put, get_help, get_value_source, once, subscribe
See example of interaction with Modin configs below, as it can be seen config value can be set either by setting the environment variable or by using config API.
import os
# Setting `MODIN_STORAGE_FORMAT` environment variable.
# Also can be set outside the script.
os.environ["MODIN_STORAGE_FORMAT"] = "OmniSci"
import modin.config
import modin.pandas as pd
# Checking initially set `StorageFormat` config,
# which corresponds to `MODIN_STORAGE_FORMAT` environment
# variable
print(modin.config.StorageFormat.get()) # prints 'Omnisci'
# Checking default value of `NPartitions`
print(modin.config.NPartitions.get()) # prints '8'
# Changing value of `NPartitions`
modin.config.NPartitions.put(16)
print(modin.config.NPartitions.get()) # prints '16'