Food Desert commited on
Commit
d4b525d
·
1 Parent(s): 29b12cd

Document GitHub model artifact push policy

Browse files
Files changed (1) hide show
  1. AGENTS.md +19 -0
AGENTS.md CHANGED
@@ -26,6 +26,25 @@
26
  - `github` => `https://github.com/FoodDesert/Prompt_Squirrel_RAG.git`
27
  - `origin` => `https://huggingface.co/spaces/FoodDesert/Prompt_Squirrel_RAG`
28
  - For code collaboration, prefer explicit GitHub remote commands to avoid pushing code to Hugging Face remote.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
 
30
  ## Mandatory agent bootstrap for any new workspace
31
  - Always run these first, in order:
 
26
  - `github` => `https://github.com/FoodDesert/Prompt_Squirrel_RAG.git`
27
  - `origin` => `https://huggingface.co/spaces/FoodDesert/Prompt_Squirrel_RAG`
28
  - For code collaboration, prefer explicit GitHub remote commands to avoid pushing code to Hugging Face remote.
29
+ - Do **not** push model/checkpoint artifacts to GitHub. GitHub is for code, docs,
30
+ tests, and lightweight config only; model files belong on the Hugging Face
31
+ remote (`origin`) or local disk.
32
+ - Before any `git push github ...`, inspect pending commits with:
33
+ - `git log --oneline github/main..HEAD`
34
+ - `git diff --stat github/main..HEAD`
35
+ - `git diff --name-only github/main..HEAD`
36
+ - If pending commits touch model/checkpoint paths or large ML artifacts, stop and
37
+ create a code-only GitHub path instead of pushing them. Treat these paths as
38
+ blocked for GitHub pushes:
39
+ - `models/`
40
+ - `*.safetensors`
41
+ - `*.bin`
42
+ - `*.pt`
43
+ - `*.pth`
44
+ - `*.onnx`
45
+ - tokenizer/checkpoint bundles under `models/finetune/`
46
+ - If deployment to Hugging Face needs model artifacts, push those only to
47
+ `origin`, never to `github`.
48
 
49
  ## Mandatory agent bootstrap for any new workspace
50
  - Always run these first, in order: