Add documentation for Settings and Constants management #1521
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: elronbandel <[email protected]>
…and environment variable details Signed-off-by: elronbandel <[email protected]>
…es and descriptions Signed-off-by: elronbandel <[email protected]>
yoavkatz
reviewed
Jan 19, 2025
| .. _settings: | ||
|
|
||
| ===================================== | ||
| Library Settings and Constants |
There was a problem hiding this comment.
Will any user need to access constants? For the list, they seem internal only.
These could be part of the code documentation. Putting them here adds complexity in the explanation for most users.
yoavkatz
reviewed
Jan 19, 2025
| - Simplify debugging and testing. | ||
| - Enable dynamic configuration using environment variables or runtime contexts. | ||
|
|
||
| Adding New Settings |
There was a problem hiding this comment.
This is not for users, only for contributors. I don't think we should document it in this tutorial. Only in the code (at latest as a last step - "for developers").
yoavkatz
reviewed
Jan 19, 2025
| - Use a clear and descriptive name for the setting. | ||
| - Always specify the type as one of `int`, `float`, or `bool`. | ||
|
|
||
| Adding New Constants |
There was a problem hiding this comment.
Moreover here, constants are not to be added by users.
yoavkatz
reviewed
Jan 19, 2025
| Using Settings Context | ||
| ====================== | ||
|
|
||
| The :class:`Settings <settings_utils.Settings>` class provides a `context` manager to temporarily override settings within a specific block of code. After exiting the block, the settings revert to their original values. |
yoavkatz
reviewed
Jan 19, 2025
| - bool | ||
| - False | ||
| - UNITXT_ALLOW_UNVERIFIED_CODE | ||
| - Enables or disables execution of unverified code. |
There was a problem hiding this comment.
Suggested change
| - Enables or disables execution of unverified code. | |
| - Enables or disables execution of unverified code. Unverified code includes executable code from HF datasets and calls to ExecuteExpressions or other operators that run user code. This ensure only trusted code is executed. |
yoavkatz
reviewed
Jan 19, 2025
| - bool | ||
| - False | ||
| - UNITXT_USE_ONLY_LOCAL_CATALOGS | ||
| - Restricts operations to use only local catalogs. |
There was a problem hiding this comment.
Suggested change
| - Restricts operations to use only local catalogs. | |
| - Restricts loading of artifacts to only use local catalogs on local filesystems (and not remote GitHub repos). |
yoavkatz
reviewed
Jan 19, 2025
| - int | ||
| - None | ||
| - UNITXT_GLOBAL_LOADER_LIMIT | ||
| - Sets a limit on the number of global data loaders. |
There was a problem hiding this comment.
It is default value for "loader_limit"?
yoavkatz
reviewed
Jan 19, 2025
| - None | ||
| - None | ||
| - UNITXT_CATALOGS | ||
| - Specifies the catalogs configuration. |
yoavkatz
reviewed
Jan 19, 2025
| - None | ||
| - None | ||
| - UNITXT_ARTIFACTORIES | ||
| - Defines the artifact storage configuration. |
yoavkatz
reviewed
Jan 19, 2025
| - str | ||
| - "dataset_recipe" | ||
| - UNITXT_DEFAULT_RECIPE | ||
| - Specifies the default recipe for datasets. |
There was a problem hiding this comment.
Is it needed? What can it be set to?
yoavkatz
reviewed
Jan 19, 2025
| - bool | ||
| - False | ||
| - UNITXT_USE_EAGER_EXECUTION | ||
| - Enables eager execution for tasks. |
yoavkatz
reviewed
Jan 19, 2025
| - list | ||
| - [] | ||
| - UNITXT_REMOTE_METRICS | ||
| - Defines a list of configurations for remote metrics. |
There was a problem hiding this comment.
This is not really checked. Should we keep it?
yoavkatz
reviewed
Jan 19, 2025
| - bool | ||
| - False | ||
| - UNITXT_TEST_CARD_DISABLE | ||
| - Disables the use of test cards when enabled. |
yoavkatz
reviewed
Jan 19, 2025
| - bool | ||
| - False | ||
| - UNITXT_TEST_METRIC_DISABLE | ||
| - Disables the use of test metrics when enabled. |
yoavkatz
reviewed
Jan 19, 2025
| - bool | ||
| - False | ||
| - UNITXT_SKIP_ARTIFACTS_PREPARE_AND_VERIFY | ||
| - Skips preparation and verification of artifacts. |
yoavkatz
reviewed
Jan 19, 2025
| - bool | ||
| - True | ||
| - UNITXT_DISABLE_HF_DATASETS_CACHE | ||
| - Disables caching for Hugging Face datasets. |
There was a problem hiding this comment.
This is an important one. Need to describe the behavior, why caching is disabled by default and what changing means.
yoavkatz
reviewed
Jan 19, 2025
| - int | ||
| - 1 | ||
| - UNITXT_LOADER_CACHE_SIZE | ||
| - Sets the cache size for data loaders. |
yoavkatz
reviewed
Jan 19, 2025
| - bool | ||
| - True | ||
| - UNITXT_TASK_DATA_AS_TEXT | ||
| - Enables representation of task data as plain text. |
yoavkatz
reviewed
Jan 19, 2025
| - None | ||
| - None | ||
| - UNITXT_DEFAULT_FORMAT | ||
| - Defines the default format for data processing. |
yoavkatz
reviewed
Jan 19, 2025
| - str | ||
| - "watsonx" | ||
| - UNITXT_DEFAULT_PROVIDER | ||
| - Specifies the default provider for tasks. |
There was a problem hiding this comment.
Suggested change
| - Specifies the default provider for tasks. | |
| - Defines the default provider used by CrossProviderInferenceEngine. Used to set the change the platform (OpenAI, HF, Watson) used for inference calls and LLM as Judges without changing code. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #1517