Skip to content

Commit b24ac4b

Browse files
authored
interface doc update (EleutherAI#1807)
1 parent fe9fef4 commit b24ac4b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/interface.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,12 @@ This mode supports a number of command-line arguments, the details of which can
5050

5151
* `--wandb_args`: Tracks logging to Weights and Biases for evaluation runs and includes args passed to `wandb.init`, such as `project` and `job_type`. Full list (here.)[https://docs.wandb.ai/ref/python/init]. e.g., ```--wandb_args project=test-project,name=test-run```
5252

53-
* `--hf_hub_log_args`: To push results and samples to the Hugging Face Hub. First ensure an access token with write access is set in the `HF_TOKEN` environment variable. Then, use this flag to specify the organization, repository name, repository visibility, and whether to push results and samples to the Hub. e.g., ```--hf_hub_log_args hub_results_org=EleutherAI,hub_repo_name=lm-eval-results,public_repo=False,push_samples_to_hub=True```
54-
55-
53+
* `--hf_hub_log_args` : Logs evaluation results to Hugging Face Hub. Accepts a string with the arguments separated by commas. Available arguments:
54+
* `hub_results_org` - organization name on Hugging Face Hub, e.g., `EleutherAI`,
55+
* `hub_repo_name` - repository name on Hugging Face Hub, e.g., `lm-eval-results`,
56+
* `push_results_to_hub` - whether to push results to Hugging Face Hub, can be `True` or `False`,
57+
* `push_samples_to_hub` - whether to push samples results to Hugging Face Hub, can be `True` or `False`. Requires `--log_samples` to be set,
58+
* `public_repo` - whether the repository is public, can be `True` or `False`,
5659

5760
## External Library Usage
5861

0 commit comments

Comments
 (0)