Skip to content

doc : update readme - update and add installation instruction #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GoGoPen wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −1
Open

doc : update readme - update and add installation instruction #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,27 @@ ByteDance Intelligent Creation

## 🔧 Requirements and Installation

### Dependencies
Python Version: >=3.10, <=3.12

Simply run this one-line command to install (feel free to create a `python3` virtual environment before you run):

```bash
pip install -r requirements.txt
```
As the weights files are downloading from Hugging Face, you will need to install huggingface-cli, git, and git-lfs. Assume that you have git installed.
```bash
git lfs install
pip install -U "huggingface_hub[cli]"
```

Then, generate your access token according to Hugging Face Security Tokens and login via huggingface-cli.

If you encounter an error related to libstdc++.so.6 GLIBCXX_3.4.32, please verify your libstdc++ version and enviroment path. Try to install the updated version with the following script:

```bash
sudo apt-get update
sudo apt-get install --only-upgrade libstdc++6
```

### Memory Requirements

Expand Down