Update README.md

README.md

@@ -19,12 +19,19 @@ license: mit
 ---
 
 ## About
-This [repository](https://github.com/approach0/azbert) is a boilerplate to push a mask-filling model to the HuggingFace Model Hub.
+This repository is a boilerplate to push a mask-filling model to the HuggingFace Model Hub.
 
-### Upload to huggingface
-Download your tokenizer, model checkpoints, and optionally the training logs (`events.out.*`) to the `./ckpt` directory (do not include any large files except `pytorch_model.bin` and log files `events.out.*`).
+### Checklist
+* `git-lfs` is installed
+* tokenizer contains all the files needed: `added_tokens.json`, `special_tokens_map.json`, `tokenizer_config.json`, `vocab.txt` and `tokenizer.json`
+* no `tokenizer_file` field in `tokenizer_config.json` (sometimes it is located locally at `~/.cache`)
+
+### Upload
+1. Put the model checkpoints and optionally log files (`*.bin` and log files `events.out.*`) to the `./ckpt` directory.
+2. Add a branch `hgf` to point to your huggingface repo. For example `git remote add hgf [email protected]:approach0/mathy-vicuna-13B-FFT`
+3. Run the `upload2hgf.sh` script.
 
-Optionally, test model using the MLM task:
+### Test the MLM task (an example)
 ```sh
 pip install pya0 # for math token preprocessing
 # testing local checkpoints:
@@ -36,11 +43,3 @@ python test.py approach0/coco-mae-220 approach0/coco-mae-220
 > Modify the test examples in `test.txt` to play with it.
 > The test file is tab-separated, the first column is additional positions you want to mask for the right-side sentence (useful for masking tokens in math markups).
 > A zero means no additional mask positions.
-
-To upload to huggingface, use the `upload2hgf.sh` script.
-Before runnig this script, be sure to check:
-* `git-lfs` is installed
-* having git-remote named `hgf` reference to `https://huggingface.co/your/repo`
-* model contains all the files needed: `config.json` and `pytorch_model.bin`
-* tokenizer contains all the files needed: `added_tokens.json`, `special_tokens_map.json`, `tokenizer_config.json`, `vocab.txt` and `tokenizer.json`
-* no `tokenizer_file` field in `tokenizer_config.json` (sometimes it is located locally at `~/.cache`)