search

umami-hep / umami

Mirror of the gitlab umami project
Apache License 2.0
1 stars 0 forks source link

JOSS review: clarify in documentation what is the user-facing API #3

Closed jpata closed 10 months ago

jpata commented 1 year ago

Make it clear in the documentation what part of the library is supposed to be built on by the users, and what part is internal and may change.

philippgadow commented 12 months ago

Dear @jpata, thank you for opening the issue. We agree and have added a section about intended use in the landing page of the documentation: https://umami.docs.cern.ch

Specifically, we write:

The intended use is as a software using configuration files to carry out preprocessing, training and evaluation. It is not written with its use as a library in mind, as its core functionalities are provided by separate python modules which in turn can be installed with pip.

These are:

ATLAS flavour tagging tools Umami preprocessing puma – Plotting UMami API

Do you think this is sufficiently clear?

jpata commented 10 months ago

Resolved.