Deepjyoti commited on
Commit
85e983d
·
verified ·
1 Parent(s): f338384

document download options (git-lfs, hf download, --model-id)

Browse files
Files changed (1) hide show
  1. README.md +25 -2
README.md CHANGED
@@ -91,8 +91,31 @@ CUDA is used automatically when available; the model never requires it.
91
 
92
  ### Download from the Hub
93
 
94
- Files are included in this repository, but they can also be fetched
95
- automatically:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
96
 
97
  ```bash
98
  python inference.py \
 
91
 
92
  ### Download from the Hub
93
 
94
+ The weights are stored as a Git LFS object. If you `git clone` this repo,
95
+ install git-lfs first or you will only get small LFS *pointer* files:
96
+
97
+ ```bash
98
+ git lfs install
99
+ git clone https://huggingface.co/Deepjyoti/shakespeare-GPT
100
+ cd shakespeare-GPT
101
+ pip install -r requirements.txt
102
+ python inference.py --prompt "ROMEO:"
103
+ ```
104
+
105
+ Alternatively, download the files with the `hf` / `huggingface_hub` tooling
106
+ (no git-lfs needed):
107
+
108
+ ```bash
109
+ pip install -r requirements.txt
110
+
111
+ # hf CLI
112
+ hf download Deepjyoti/shakespeare-GPT --local-dir .
113
+
114
+ # or Python
115
+ python -c "from huggingface_hub import snapshot_download; snapshot_download('Deepjyoti/shakespeare-GPT', local_dir='.')"
116
+ ```
117
+
118
+ You can also let `inference.py` fetch the weights automatically:
119
 
120
  ```bash
121
  python inference.py \