diff --git a/README.md b/README.md index e2dad5c03b08c33ab347c95e2c126230398eabc1..341971e81a1040b83d21b3051849558987af7c8f 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,19 @@ Previously created projects can be inspected in iypthon like ipython -i -m KerasROOTClassification.browse <project-dir> ``` +Or in a script you can initialise a project by just specifying the path to the project directory. This is especially useful when you want to compare different projects: + +```python +from KerasROOTClassification import ClassificationProject +from KerasROOTClassification.compare import overlay_ROC, overlay_loss + +c1 = ClassificationProject("path/to/project1") +c2 = ClassificationProject("path/to/project2") + +overlay_ROC("ROC_overlay.pdf", c1, c2) +overlay_loss("loss_overlay.pdf", c1, c2) +``` + # Conda setup An example for a mini conda setup that contains the nescessary packages: