doc

Author: dweindl

petab/v2/problem.py

@@ -10,7 +10,7 @@
 from math import nan
 from numbers import Number
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 import pandas as pd
 import sympy as sp
@@ -1099,6 +1099,12 @@ def __iadd__(self, other):
     def model_dump(self, **kwargs) -> dict[str, Any]:
         """Convert this Problem to a dictionary.
 
+        This function is intended for debugging purposes and should not be
+        used for serialization. The output of this function may change
+        without notice.
+
+        The output includes all PEtab tables, but not the model itself.
+
         See `pydantic.BaseModel.model_dump <https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_dump>`__
         for details.