Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
felixhultin authored Dec 2, 2024
1 parent e915cc4 commit 7c588be
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# Introduction

This is a toolkit for automatically creating a HuggingFace repository for a Språkbanken resource.
This is a toolkit for automatically creating a Hugging Face repository for a Språkbanken resource.

# Usage

TBD
sb2hf is a command-line tool which creates a Hugging Face repository from a Språkbanken resource url (found at https://spraakbanken.gu.se/resurser). For example, if an authenticated user of the ```sbx`` organization of the user runs this:

```
python sb2hf.py https://spraakbanken.gu.se/resurser/forarbeten1734 --push-to-hub
```

This dataset with the same resource name will be automatically uploaded: https://huggingface.co/datasets/sbx/forarbeten1734.

To use this outside the Språkbanken Text organization, simply specify your own organization or user under the ``--hf-namespace`` argument.

0 comments on commit 7c588be

Please sign in to comment.