lukemerrick commited on
Commit
8ff8f60
·
verified ·
1 Parent(s): 504c6ae

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -0
README.md CHANGED
@@ -9,4 +9,26 @@ license_link: LICENSE
9
  This dataset coresponds to the walkthrough example for using the [Arctic Embed training code in ArcticTraining](https://github.com/snowflakedb/ArcticTraining/blob/main/projects/arctic_embed/examples/finetune_models/README.md). See [that README](https://github.com/snowflakedb/ArcticTraining/blob/main/projects/arctic_embed/examples/finetune_models/README.md) for more details.
10
 
11
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
  <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=11c9f5e7-c00f-43e8-8c22-630379baeb05" />
 
9
  This dataset coresponds to the walkthrough example for using the [Arctic Embed training code in ArcticTraining](https://github.com/snowflakedb/ArcticTraining/blob/main/projects/arctic_embed/examples/finetune_models/README.md). See [that README](https://github.com/snowflakedb/ArcticTraining/blob/main/projects/arctic_embed/examples/finetune_models/README.md) for more details.
10
 
11
 
12
+ ## Example: Selective downloads via Git LFS
13
+
14
+ Since this dataset contains various intermediate files not necessary for training, it can be helpful to use the Git LFS backend of Hugging Face Datasets to pull select files.
15
+
16
+ ``` shell
17
+ # First, ensure you have installed git-lfs (see `https://git-lfs.com/` for documentation).
18
+ git lfs install
19
+
20
+ # Clone the full precomputed data repository without large files as our `data/` directory.
21
+ mv ./data/.gitignore ./data.gitignore
22
+ rmdir ./data
23
+ GIT_LFS_SKIP_SMUDGE=1 git clone https://hf.co/datasets/Snowflake/arctic-embed-ft-v1.git ./data
24
+ mv ./data.gitignore ./data/.gitignore
25
+
26
+ # Ensure we have all the files you need for training downloaded from LFS.
27
+ cd arctic-embed-ft-v1/
28
+ git lfs pull --include="combined/pretokenized/example_dot95/" --include="eval/"
29
+
30
+ # Optional: Download more large files (e.g. everything but the very large precomputed embeddings).
31
+ git lfs pull --exclude="*document_embeddings*" --exclude="*query_embeddings*"
32
+ ````
33
+
34
  <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=11c9f5e7-c00f-43e8-8c22-630379baeb05" />