Update README.md
Browse files
README.md
CHANGED
|
@@ -14,7 +14,7 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
|
|
| 14 |
|
| 15 |
### Local Install
|
| 16 |
|
| 17 |
-
For optimal performance, run this application
|
| 18 |
|
| 19 |
Next, download all the files in this repository to your computer, preserving the file structure in the process. To my knowledge, Hugging Face does not provide a way to do this via the GUI other than downloading each file individually. If you are comfortable with the terminal, you can clone the repository using [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Git-lfs](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage?platform=windows).
|
| 20 |
|
|
@@ -24,5 +24,5 @@ Wait for the container to build and install the requirements. This could take fi
|
|
| 24 |
|
| 25 |
### Troubleshooting
|
| 26 |
|
| 27 |
-
- If the container fails to build, look for a part of the error message that says `"bind": bind source path does not exist:` then delete the wayland-0 and wayland-0.lock files in the path specified by that portion of the error. On a default Ubuntu installation, the path is `/run/user/1000/wayland-0`. This advice is taken from [here](https://dev.to/crumdev/vscode-dev-container-failing-to-build-ap4).
|
| 28 |
- If the app starts to run in the Dev Container but spontaneously kills itself, increase the maximum RAM and SWAP allocations in the Docker Desktop application settings.
|
|
|
|
| 14 |
|
| 15 |
### Local Install
|
| 16 |
|
| 17 |
+
For optimal performance, run this application on a computer with a performant CPU and at least 16GB of RAM. Using Dev Containers within Visual Studio Code (VS Code) is the easiest way to run the application locally. To get started, follow [this](https://code.visualstudio.com/docs/devcontainers/tutorial) tutorial until the "Check Installation" step.
|
| 18 |
|
| 19 |
Next, download all the files in this repository to your computer, preserving the file structure in the process. To my knowledge, Hugging Face does not provide a way to do this via the GUI other than downloading each file individually. If you are comfortable with the terminal, you can clone the repository using [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Git-lfs](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage?platform=windows).
|
| 20 |
|
|
|
|
| 24 |
|
| 25 |
### Troubleshooting
|
| 26 |
|
| 27 |
+
- If the container fails to build, look for a part of the error message that says `"bind": bind source path does not exist:` then delete the `wayland-0` and `wayland-0.lock` files in the path specified by that portion of the error. On a default Ubuntu installation, the path is `/run/user/1000/wayland-0`. This advice is taken from [here](https://dev.to/crumdev/vscode-dev-container-failing-to-build-ap4).
|
| 28 |
- If the app starts to run in the Dev Container but spontaneously kills itself, increase the maximum RAM and SWAP allocations in the Docker Desktop application settings.
|