Connect
Most of the advanced features are enabled/disabled via px.connect()
parameters. Example usage is shown below.
- It is up to the user to enable the features they need.
- Most of these features are independent of each other and can be used together or separately.
- It is recommended to call
px.connect()at the beginning of your session to start using the advanced features.
Simple Config
Following is the simple config with experiment path, logging options and cache options. See, corresponding pages for more details.
import proxai as px
px.connect(
experiment_path='translation/en-to-fr/experiment_1',
logging_options=px.LoggingOptions(logging_path='~/proxai-logs'),
cache_options=px.CacheOptions(cache_path='~/proxai-cache'))More Customized Config
Following example shows the more customized possible config. Each option has its own page with more details.
import proxai as px
px.connect(
experiment_path='translation/en-to-fr/experiment_1',
logging_options=px.LoggingOptions(
logging_path='~/proxai-logs',
stdout=True,
hide_sensitive_content=True),
cache_options=px.CacheOptions(
cache_path='~/proxai-cache',
Parameters
px.connect() parameters:
| Option | Type | Default Value | Description |
|---|---|---|---|
experiment_path | str | None | Path of the experiment for current session. |
logging_options | px.types.LoggingOptions | None | Logging options for current session. |
cache_options | px.types.CacheOptions | None | Cache options for current session. See, page. |