jpata commited on
Commit
e65f235
·
1 Parent(s): d14c096

update readme

Browse files
cms/2024_04_05/pyg-cms_20240324_235743_208080/README.md CHANGED
@@ -20,19 +20,37 @@ This model reconstructs particles in a detector, based on the tracks and calorim
20
  ### Direct Use
21
 
22
  This model may be used to study the physics and computational performance on ML-based reconstruction in CMS simulation.
23
- It should only be used within the CMS collaboration.
24
 
25
  ### Out-of-Scope Use
26
 
27
  This model is not intended for physics measurements on real data.
 
28
 
29
  ## Bias, Risks, and Limitations
30
 
31
  The model has only been trained on simulation data and has not been validated against real data.
32
- It should not be used outside of the CMS collaboration.
33
 
34
  ## How to Get Started with the Model
35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
  ## Training Details
37
 
38
  Trained for 32 epochs on 1x A100 80GB for approximately 6 days.
@@ -41,6 +59,8 @@ The training was done with bfloat16.
41
  ### Training Data
42
 
43
  Trained on 400k events from `cms_pf_ttbar`, version `v1.7.1`.
 
 
44
  https://github.com/jpata/particleflow/blob/v1.7.0/mlpf/heptfds/cms_pf/ttbar.py
45
 
46
  ## Model Card Contact
 
20
  ### Direct Use
21
 
22
  This model may be used to study the physics and computational performance on ML-based reconstruction in CMS simulation.
23
+ It should **only** be used **within** the CMS collaboration.
24
 
25
  ### Out-of-Scope Use
26
 
27
  This model is not intended for physics measurements on real data.
28
+ It should **not** be used **outside** of the CMS collaboration.
29
 
30
  ## Bias, Risks, and Limitations
31
 
32
  The model has only been trained on simulation data and has not been validated against real data.
 
33
 
34
  ## How to Get Started with the Model
35
 
36
+ ```
37
+ git clone https://github.com/jpata/particleflow/releases/tag/v1.7.0
38
+ cd particleflow
39
+
40
+ wget https://hep.kbfi.ee/~joosep/pytorch.simg
41
+
42
+ mkdir -p experiments/pyg-cms_20240324_235743_208080/checkpoints/
43
+
44
+ wget https://huggingface.co/jpata/particleflow/resolve/main/cms/2024_04_05/pyg-cms_20240324_235743_208080/checkpoint-32-17.877384.pth
45
+ mv checkpoint-32-17.877384.pth experiments/pyg-cms_20240324_235743_208080/checkpoints/
46
+
47
+ wget https://huggingface.co/jpata/particleflow/raw/main/cms/2024_04_05/pyg-cms_20240324_235743_208080/train-config.yaml
48
+ mv train-config.yaml experiments/pyg-cms_20240324_235743_208080/
49
+
50
+ #Run the inference on the held-out dataset
51
+ singularity exec --nv pytorch.simg python3 mlpf/pyg_pipeline.py --config parameters/pytorch/pyg-cms.yaml --gpus 1 --experiments-dir experiments/ --dataset cms --conv-type attention --gpu-batch-multiplier 10 --dtype bfloat16 --load experiments/pyg-cms_20240324_235743_208080/checkpoints/checkpoint-32-17.877384.pth --test
52
+ ```
53
+
54
  ## Training Details
55
 
56
  Trained for 32 epochs on 1x A100 80GB for approximately 6 days.
 
59
  ### Training Data
60
 
61
  Trained on 400k events from `cms_pf_ttbar`, version `v1.7.1`.
62
+ The dataset is available at `/eos/user/j/jpata/mlpf/tensorflow_datasets/cms/cms_pf_ttbar/1.7.1`.
63
+
64
  https://github.com/jpata/particleflow/blob/v1.7.0/mlpf/heptfds/cms_pf/ttbar.py
65
 
66
  ## Model Card Contact