https://github.com/nateraw/huggingface-sync-action

GitHub action that'll sync files from a GitHub Repo with the Hugging Face Hub 🤗
https://github.com/nateraw/huggingface-sync-action

github-actions huggingface

Last synced: 3 months ago
JSON representation

GitHub action that'll sync files from a GitHub Repo with the Hugging Face Hub 🤗

• Host: GitHub
• URL: https://github.com/nateraw/huggingface-sync-action
• Owner: nateraw
• Created: 2022-10-16T21:06:47.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-14T06:33:50.000Z (over 1 year ago)
• Last Synced: 2024-07-22T15:42:00.504Z (4 months ago)
• Topics: github-actions, huggingface
• Language: Python
• Homepage: https://huggingface.co
• Size: 29.3 KB
• Stars: 64
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# huggingface-sync-action

A GitHub action that'll sync files from a GitHub repo with the Hugging Face Hub. 🤗

A simple example repo using this can be found [here](https://github.com/nateraw/test-spaces-app).

## Usage

The first step is to add a Hugging Face token with write access to your repo as a GitHub Secret. Below, mine is called `HF_TOKEN`. Then, you can use this action in your repo as shown below. 🤗

```yaml

uses: nateraw/[email protected]

with:

  # The github repo you are syncing from. Required.

  github_repo_id: ''

  # The Hugging Face repo id you want to sync to. (ex. 'username/reponame')

  # A repo with this name will be created if it doesn't exist. Required.

  huggingface_repo_id: ''

  # Hugging Face token with write access. Required.

  # Here, we provide a token that we called `HF_TOKEN` when we added the secret to our GitHub repo.

  hf_token: ${{ secrets.HF_TOKEN }}

  # The type of repo you are syncing to: model, dataset, or space.

  # Defaults to space.

  repo_type: 'space'

  

  # If true and the Hugging Face repo doesn't already exist, it will be created

  # as a private repo.

  #

  # Note: this param has no effect if the repo already exists.

  private: false

  # If repo type is space, specify a space_sdk. One of: streamlit, gradio, or static

  #

  # This option is especially important if the repo has not been created yet.

  # It won't really be used if the repo already exists.

  space_sdk: 'gradio'

  

  # If provided, subdirectory will determine which directory of the repo will be synced.

  # By default, this action syncs the entire GitHub repo.

  #

  # An example using this option can be seen here:

  # https://github.com/huggingface/fuego/blob/830ed98/.github/workflows/sync-with-huggingface.yml

  subdirectory: ''

```