Skip to content

Commit

Permalink
Merge pull request #20 from optuna/remove-config-toml
Browse files Browse the repository at this point in the history
Remove documents about `config.toml`
  • Loading branch information
HideakiImamura authored May 17, 2024
2 parents e74a81c + 5b8c26b commit 5ac19bf
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,19 @@ How to opt-out of the anonymous analytics?
OptunaHub collects anonymous usage data to improve the service.
The data is used to understand how users interact with the service and to identify areas for improvement.

Youn can opt-out of the anonymous analytics in the following ways.

- By setting the environment variable `OPTUNAHUB_NO_ANALYTICS` to `1`
- By setting `no_analytics = false` in `config.toml`
Youn can opt-out of the anonymous analytics by setting the environment variable `OPTUNAHUB_NO_ANALYTICS` to `1`

.. code-block:: shell
export OPTUNAHUB_NO_ANALYTICS=1
`config.toml`

.. code-block:: toml
no_analytics = false
The settings are prioritized in the order listed above.

The configuration file (`config.toml`) of OptunaHub is placed in the following locations.

- (UNIX-like) `XDG_CONFIG_HOME/optunahub/config.toml`
- (Windows) `%APPDATA%/optunahub/config.toml`

`XDG_CONFIG_HOME` is usually `~/.config` on UNIX-like systems.


How to configure the package cache?
-----------------------------------

OptunaHub caches the downloaded packages in the following locations.

- The directory defined by `OPTUNAHUB_CACHE_HOME` environment variable
- The `cache_home` value in `config.toml`
- (UNIX-like) `XDG_CACHE_HOME/optunahub`
- (Windows) `%LOCALAPPDATA%/optunahub`

Expand Down

0 comments on commit 5ac19bf

Please sign in to comment.