Skip to content

Commit

Permalink
docs: add more information for pushing records
Browse files Browse the repository at this point in the history
  • Loading branch information
burtenshaw committed Jul 11, 2024
1 parent a310ba6 commit ffce313
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion argilla/docs/how_to_guides/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Check the [Dataset - Python Reference](../reference/argilla/datasets/dataset.md)

## Export an `rg.Dataset` from Argilla

First, we will go through exporting a complete dataset from Argilla. This includes the dataset's configuration and records. All of these methods use the `rg.Dataset.from_*` and `rg.Dataset.to_*` methods.
First, we will go through exporting a complete dataset from Argilla. This includes the dataset's setting and records. All of these methods use the `rg.Dataset.from_*` and `rg.Dataset.to_*` methods.

### Push an Argilla dataset to the Hugging Face Hub

Expand All @@ -35,6 +35,13 @@ dataset.to_hub(repo_id="<repo_id>")
dataset.to_hub(repo_id="<repo_id>", with_records=False)
```

With the dataset's confiugration you could then make changes to the dataset's settings, or add records via the `datasets` package.

```python
hf_dataset = load_dataset("<repo_id>")
dataset.log(hf_dataset)
```

### Pull an Argilla dataset from the Hugging Face Hub

You can pull a dataset from the Hugging Face Hub to Argilla. This is useful if you want to restore a dataset's configuration. You can pull the dataset from the Hugging Face Hub using the `rg.Dataset.from_hub` method.
Expand Down

0 comments on commit ffce313

Please sign in to comment.