ho22joshua commited on
Commit
bccdb43
·
1 Parent(s): 70ee5cc

docs: protect paper README

Browse files
Files changed (2) hide show
  1. AGENTS.md +5 -0
  2. README.md +0 -6
AGENTS.md CHANGED
@@ -22,6 +22,11 @@ Do not design shared infrastructure around assumptions that only apply to GNNs.
22
 
23
  ## Source of truth
24
 
 
 
 
 
 
25
  Before making non-trivial changes, inspect:
26
 
27
  ```text
 
22
 
23
  ## Source of truth
24
 
25
+ `README.md` is the protected research paper/model-card artifact. Do not edit,
26
+ reformat, or append package instructions to it. Put human-readable usage
27
+ instructions in `docs/quickstart.md` and developer guidance in
28
+ `README_PROJECT.md`.
29
+
30
  Before making non-trivial changes, inspect:
31
 
32
  ```text
README.md CHANGED
@@ -11,12 +11,6 @@ datasets:
11
  - HWresearch/Delphes
12
  ---
13
 
14
- ## Using the package
15
-
16
- This file is the research paper and model card. For installation and practical
17
- CLI instructions, start with the [package quickstart](docs/quickstart.md).
18
- The deeper developer guide is [README_PROJECT.md](README_PROJECT.md).
19
-
20
  # Pretrained Event Classification Model for High Energy Physics Analysis
21
 
22
  Joshua Ho, Ryan Roberts, Shuo Han, and Haichen Wang
 
11
  - HWresearch/Delphes
12
  ---
13
 
 
 
 
 
 
 
14
  # Pretrained Event Classification Model for High Energy Physics Analysis
15
 
16
  Joshua Ho, Ryan Roberts, Shuo Han, and Haichen Wang