Skip to content

Commit c662104

Browse files
authored
Merge pull request #6 from alibuild/alibot-cleanup-ml-17419
[MegaLinter] Apply linters automatic fixes to #17419
2 parents 9459177 + 186bf3c commit c662104

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

Tools/PIDFeatureExtractor/README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ Mode is a runtime switch - enable `processData` for real data or
3535

3636
### PidFeatureExtractor options
3737

38-
| Option | Default | What it does |
39-
|---|---|---|
40-
| `outputPath` | `pid_features` | Output file base name |
41-
| `exportROOT` | `true` | Write a ROOT file |
42-
| `exportCsv` | `false` | Also write CSV |
43-
| `etaMin` / `etaMax` | `-99` / `99` | Eta cut - wide open by default (no cut) |
44-
| `ptMin` / `ptMax` | `0` / `9999` | pT cut, GeV/c - wide open by default |
45-
| `dcaXYMax` / `dcaZMax` | `9999` / `9999` | DCA cuts, cm - wide open by default |
46-
| `itsMinClusters` | `0` | Minimum ITS clusters - `0` = no cut |
47-
| `tpcMinClusters` | `0` | Minimum TPC clusters - `0` = no cut |
48-
| `computeBayesianPid` | `true` | Compute the comparison Bayesian posterior |
49-
| `bayesianPriors` | flat (`1,1,1,1`) | Per-species priors `[pi, ka, pr, el]` for the Bayesian posterior |
38+
| Option | Default | What it does |
39+
|------------------------|------------------|------------------------------------------------------------------|
40+
| `outputPath` | `pid_features` | Output file base name |
41+
| `exportROOT` | `true` | Write a ROOT file |
42+
| `exportCsv` | `false` | Also write CSV |
43+
| `etaMin` / `etaMax` | `-99` / `99` | Eta cut - wide open by default (no cut) |
44+
| `ptMin` / `ptMax` | `0` / `9999` | pT cut, GeV/c - wide open by default |
45+
| `dcaXYMax` / `dcaZMax` | `9999` / `9999` | DCA cuts, cm - wide open by default |
46+
| `itsMinClusters` | `0` | Minimum ITS clusters - `0` = no cut |
47+
| `tpcMinClusters` | `0` | Minimum TPC clusters - `0` = no cut |
48+
| `computeBayesianPid` | `true` | Compute the comparison Bayesian posterior |
49+
| `bayesianPriors` | flat (`1,1,1,1`) | Per-species priors `[pi, ka, pr, el]` for the Bayesian posterior |
5050

5151
All the cuts default to "off" - tighten them in your config if you want
5252
quality selection applied here rather than downstream.
@@ -73,24 +73,24 @@ detector miss would look.
7373

7474
### PidOnnxInference options
7575

76-
| Option | Default | What it does |
77-
|---|---|---|
78-
| `inputRootFile` | `pid_features_data.root` | File written by `PidFeatureExtractor` |
79-
| `inputTreeName` | `pid_features` | Tree name inside it |
80-
| `outputPath` | `pid_predictions` | Output file base name |
81-
| `exportCsv` | `false` | Also write CSV |
82-
| `loadModelFromCcdb` | `true` | Load the model from CCDB; set `false` to use a local file instead |
83-
| `ccdbUrl` | `http://alice-ccdb.cern.ch` | |
84-
| `modelPathsCcdb` | *(placeholder)* | CCDB path to your model - set this to a real path before running |
85-
| `timestampCcdb` | `-1` | `-1` = latest |
86-
| `onnxFileNames` | `pid_feature_model.onnx` | Local model file, used when `loadModelFromCcdb` is `false` |
87-
| `useTPC` | `true` | Include TPC. Set `false` to exclude it from inference regardless of the data |
88-
| `useTOF` | `true` | Include TOF |
89-
| `useTRD` | `true` | Include TRD |
90-
| `useITS` | `true` | Include ITS |
91-
| `useEMCal` | `true` | Include EMCal |
92-
| `useHMPID` | `true` | Include HMPID |
93-
| `useCentrality` | `true` | Include event centrality |
76+
| Option | Default | What it does |
77+
|---------------------|-----------------------------|------------------------------------------------------------------------------|
78+
| `inputRootFile` | `pid_features_data.root` | File written by `PidFeatureExtractor` |
79+
| `inputTreeName` | `pid_features` | Tree name inside it |
80+
| `outputPath` | `pid_predictions` | Output file base name |
81+
| `exportCsv` | `false` | Also write CSV |
82+
| `loadModelFromCcdb` | `true` | Load the model from CCDB; set `false` to use a local file instead |
83+
| `ccdbUrl` | `http://alice-ccdb.cern.ch` | |
84+
| `modelPathsCcdb` | *(placeholder)* | CCDB path to your model - set this to a real path before running |
85+
| `timestampCcdb` | `-1` | `-1` = latest |
86+
| `onnxFileNames` | `pid_feature_model.onnx` | Local model file, used when `loadModelFromCcdb` is `false` |
87+
| `useTPC` | `true` | Include TPC. Set `false` to exclude it from inference regardless of the data |
88+
| `useTOF` | `true` | Include TOF |
89+
| `useTRD` | `true` | Include TRD |
90+
| `useITS` | `true` | Include ITS |
91+
| `useEMCal` | `true` | Include EMCal |
92+
| `useHMPID` | `true` | Include HMPID |
93+
| `useCentrality` | `true` | Include event centrality |
9494

9595
Output columns are `mlProbPi`, `mlProbKa`, `mlProbPr`, `mlProbEl` (one
9696
probability per species) and `mlPredictedClass` (the most likely species,

0 commit comments

Comments
 (0)