-
-
Notifications
You must be signed in to change notification settings - Fork 0
Frequently Asked Questions
This page answers some of the most common questions about the Hugging Face Backup Tool.
Q: What is the Hugging Face Backup Tool?
A: The Hugging Face Backup Tool is a desktop application that provides a user-friendly way to back up your local machine's files (models, datasets, spaces) to the Hugging Face Hub.
Q: What are the main benefits of using this tool?
A: It offers a graphical user interface (GUI), making it more intuitive than using the command-line interface (CLI) and simplifies backing up your local models, datasets, and spaces to the Hugging Face Hub.
Q: What are the system requirements?
A: The tool requires Python 3.10 or higher. It should be compatible with Windows 10 or later, macOS 10.14 (Mojave) or later, and most modern Linux distributions.
Q: How do I install the tool?
A: Follow the installation instructions in the main documentation ([Link to the main documentation's Installation section]). Briefly:
- Make sure Python 3.10+ is installed.
- Clone the repository from GitHub.
- Create and activate a virtual environment.
- Install dependencies using
pip(or UV).- Run the application.
Q: I get an error during installation. What should I do?
A: Refer to the "Troubleshooting" section of the main documentation or the "Advanced Installation Guide" in the wiki ([Link to the Advanced Installation Guide]) for common installation problems and solutions.
Q: Where do I find the requirements.txt file?
A: The
requirements.txtfile should be in the root directory of the cloned repository.
Q: I'm having trouble activating the virtual environment.
A: Double-check the activation commands for your shell (e.g.,
.venv\Scripts\activateon Windows,source .venv/bin/activateon Linux/macOS). If you're using FISH, consult the instructions in the main documentation.
Q: How do I upload files?
A:
- Click "Select Directory" and choose the folder containing the files.
- Select the "File Type" from the dropdown.
- Select the files you want to upload from the file list.
- Enter the repository information (owner/username, repository name).
- Click "Upload".
Q: Where do I find my Hugging Face API token?
A: You can create a Hugging Face API token with "write" access in your Hugging Face account settings: (https://huggingface.co/settings/tokens).
Q: How do I configure the API token?
A: Click the "Edit Config (API Token)" button within the application, paste your API token, and click "Save".
Q: How do I know if the upload was successful?
A: Check the output window in the GUI. Monitor the terminal output for detailed progress and potential error messages.
Q: Why are my uploads failing?
A:
- Ensure your API token is valid and has the necessary "write" access.
- Verify that the repository ID (owner/username, repository name, and type) is correct.
- Check the "Known Issues & Workarounds" section ([Link to Known Issues]) for potential issues.
Q: Does the tool support private repositories?
A: Yes, the tool supports private repositories if you use an API token with write access to the repository.
Q: Can I create a new repository with this tool?
A: Yes, if the "Create Repository" checkbox is checked and the repository doesn't exist. (See the documentation for the use of the create repo checkbox). If there are any issues, see issues.
Q: Where can I report a bug or suggest a feature?
A: Open an issue on the project's GitHub repository ([Link to your Issues page]).
Q: I have another question. Where can I find more help?
A:
- Check the main documentation ([Link to the main documentation]).
- Browse the wiki for more detailed information ([Link to your Wiki Home Page]).
- Search existing issues on the GitHub repository ([Link to your Issues page]).
- Open a new issue on the GitHub repository if your question is not answered.