From 8fe602aefa964fe110ef59338178a5255e8aabf7 Mon Sep 17 00:00:00 2001 From: Paul Jonas Jost <70631928+PaulJonasJost@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:33:31 -0400 Subject: [PATCH] =?UTF-8?q?Added=20a=20bit=20more=20information=20to=20pet?= =?UTF-8?q?ab=20importer=20and=20objective=20function=E2=80=A6=20(#1126)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Added a bit more information to petab importer and objective function created from petab. Line with "noqa" to keep url. Closes #1047 * Moved noqa somewhere else * Apply suggestions from code review Co-authored-by: Daniel Weindl --------- Co-authored-by: Daniel Weindl --- pypesto/petab/importer.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/pypesto/petab/importer.py b/pypesto/petab/importer.py index fd1e812be..5c536128b 100644 --- a/pypesto/petab/importer.py +++ b/pypesto/petab/importer.py @@ -61,11 +61,15 @@ class PetabImporter(AmiciObjectBuilder): """ - Importer for Petab files. + Importer for PEtab files. Create an `amici.Model`, an `objective.AmiciObjective` or a - `pypesto.Problem` from Petab files. - """ + `pypesto.Problem` from PEtab files. The created objective function is a + negative log-likelihood function and can thus be negative. The actual + form of the likelihood depends on the noise model specified in the provided PEtab problem. + For more information, see + [the PEtab documentation](https://petab.readthedocs.io/en/latest/documentation_data_format.html#noise-distributions) + """ # noqa MODEL_BASE_DIR = "amici_models"