add readme

clic/clusters/v1.6/README.md

@@ -8,7 +8,7 @@ This model reconstructs particles in a detector, based on the tracks and calorim
 
 <!-- Provide a longer summary of what this model is. -->
 
-- **Developed by:** Joosep Pata, Eric Wulff, Farouk Mokhtar, Mengke Zhang, David Southwick, Maria Girone, David Southwick
+- **Developed by:** Joosep Pata, Eric Wulff, Farouk Mokhtar, Mengke Zhang, David Southwick, Maria Girone, David Southwick, Javier Duarte
 - **Model type:** graph neural network with learnable structure in locality-sensitive hashing bins
 - **License:** Apache License
 

cms/2024_04_05/pyg-cms_20240324_235743_208080/README.md

@@ -0,0 +1,48 @@
+# Model Card for cms-2024-04-05
+
+This model reconstructs particles in a detector, based on the tracks and calorimeter clusters recorded by the detector.
+
+## Model Details
+
+### Model Description
+
+- **Developed by:** Joosep Pata, Eric Wulff, Farouk Mokhtar, Javier Duarte
+- **Model type:** full attention
+- **License:** Apache License
+
+### Model Sources
+
+- **Repository:** https://github.com/jpata/particleflow/releases/tag/v1.7.0
+- **Slides:** https://indico.cern.ch/event/1399688/#1-ml-for-pf
+
+## Uses
+
+### Direct Use
+
+This model may be used to study the physics and computational performance on ML-based reconstruction in CMS simulation.
+It should only be used within the CMS collaboration.
+
+### Out-of-Scope Use
+
+This model is not intended for physics measurements on real data. 
+
+## Bias, Risks, and Limitations
+
+The model has only been trained on simulation data and has not been validated against real data.
+It should not be used outside of the CMS collaboration.
+
+## How to Get Started with the Model
+
+## Training Details
+
+### Training Data
+
+Trained on 400k events from `cms_pf_ttbar`, version `v1.7.1`.
+https://github.com/jpata/particleflow/blob/v1.7.0/mlpf/heptfds/cms_pf/ttbar.py
+
+## Model Card Contact
+
+Joosep Pata, [email protected]
+
+
+