docs: update build instructions and dependencies

This commit is contained in:
leafspark 2024-08-08 10:45:48 -07:00 committed by GitHub
parent f5b3b43d01
commit c659790942
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 17 deletions

View File

@ -42,10 +42,6 @@ ### Cross-platform
``` ```
pip install -r requirements.txt pip install -r requirements.txt
``` ```
or
```
pip install PyQt6 requests psutil shutil numpy torch safetensors gguf
```
2. Run the application: 2. Run the application:
``` ```
python src/main.py python src/main.py
@ -86,11 +82,10 @@ ## Building
### Cross-platform ### Cross-platform
```bash ```bash
cd src
pip install -U pyinstaller pip install -U pyinstaller
pyinstaller main.py --onefile ./build.sh RELEASE | DEV
cd dist/main cd build/<type>/dist/
./main ./AutoGGUF
``` ```
### Windows ### Windows
@ -101,13 +96,7 @@ ### Windows
## Dependencies ## Dependencies
- PyQt6 Find them in `requirements.txt`.
- psutil
- shutil
- numpy
- torch
- safetensors
- gguf (bundled)
## Localizations ## Localizations
@ -117,7 +106,6 @@ ## Localizations
## Known Issues ## Known Issues
- Saving preset while quantizing causes UI thread crash (planned fix: remove this feature)
- Cannot delete task while processing (planned fix: disallow deletion before cancelling or cancel automatically) - Cannot delete task while processing (planned fix: disallow deletion before cancelling or cancel automatically)
## Planned Features ## Planned Features
@ -125,6 +113,7 @@ ## Planned Features
- Actual progress bar tracking - Actual progress bar tracking
- Perplexity testing - Perplexity testing
- Time estimation for quantization - Time estimation for quantization
- `nvidia-smi` monitoring support
## Troubleshooting ## Troubleshooting
@ -136,7 +125,7 @@ ## Contributing
## User Interface ## User Interface
![image](https://github.com/user-attachments/assets/2660c841-07ba-4c3f-ae3a-e63c7068bdc1) ![image](https://github.com/user-attachments/assets/a327afb9-950d-420b-b07f-46658ffb0822)
## Stargazers ## Stargazers