flip_api.domain.interfaces.model ================================ .. py:module:: flip_api.domain.interfaces.model Classes ------- .. autoapisummary:: flip_api.domain.interfaces.model.ModelStatusEdit flip_api.domain.interfaces.model.IModelDetails flip_api.domain.interfaces.model.ISaveModel flip_api.domain.interfaces.model.IModelLog flip_api.domain.interfaces.model.ISourceLog flip_api.domain.interfaces.model.IModelStatus flip_api.domain.interfaces.model.ModelTrustIntersectStatus flip_api.domain.interfaces.model.Age flip_api.domain.interfaces.model.Gender flip_api.domain.interfaces.model.ClientVisit flip_api.domain.interfaces.model.Statistics flip_api.domain.interfaces.model.TrustsResults flip_api.domain.interfaces.model.IQuery flip_api.domain.interfaces.model.IModelResponse flip_api.domain.interfaces.model.IBuildImagesForModel flip_api.domain.interfaces.model.IDetailedModelStatus flip_api.domain.interfaces.model.ILog flip_api.domain.interfaces.model.IModelAuditAction flip_api.domain.interfaces.model.ITrainingMetricsResponse flip_api.domain.interfaces.model.IModelMetricsValue flip_api.domain.interfaces.model.IModelMetricsData flip_api.domain.interfaces.model.IModelMetrics Module Contents --------------- .. py:class:: ModelStatusEdit Bases: :py:obj:`enum.StrEnum` Enum where members are also (and must be) strings .. py:attribute:: PENDING :value: 'PENDING' .. py:class:: IModelDetails Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: name :type: str .. py:attribute:: description :type: str .. py:class:: ISaveModel Bases: :py:obj:`IModelDetails` .. py:attribute:: project_id :type: uuid.UUID .. py:class:: IModelLog Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: timestamp :type: datetime.datetime .. py:attribute:: model :type: str .. py:attribute:: status :type: str .. py:attribute:: trust :type: str | None :value: None .. py:attribute:: message :type: str .. py:class:: ISourceLog Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: _source :type: IModelLog .. py:attribute:: _id :type: str .. py:class:: IModelStatus Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: modelStatus :type: str .. py:class:: ModelTrustIntersectStatus Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: status :type: flip_api.domain.schemas.status.TrustIntersectStatus .. py:class:: Age Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: Mean :type: float .. py:class:: Gender Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: Male :type: int .. py:attribute:: Female :type: int .. py:attribute:: MissingData :type: int .. py:class:: ClientVisit Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: Emergency :type: int .. py:attribute:: Inpatient :type: int .. py:attribute:: MissingData :type: int .. py:class:: Statistics Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: TotalCount :type: int .. py:attribute:: Age :type: Statistics.Age .. py:attribute:: Gender :type: Statistics.Gender .. py:attribute:: ClientVisit :type: Statistics.ClientVisit .. py:class:: TrustsResults Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: Data :type: Statistics .. py:attribute:: TrustName :type: str .. py:class:: IQuery Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: id :type: uuid.UUID .. py:attribute:: name :type: str .. py:attribute:: query :type: str .. py:attribute:: results :type: list[TrustsResults] | None .. py:class:: IModelResponse Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: model_id :type: uuid.UUID .. py:attribute:: model_name :type: str .. py:attribute:: model_description :type: str .. py:attribute:: project_id :type: uuid.UUID .. py:attribute:: status :type: flip_api.domain.schemas.status.ModelStatus .. py:attribute:: query :type: IQuery | None .. py:attribute:: files :type: list[flip_api.db.models.main_models.UploadedFiles] | None :value: None .. py:attribute:: creation_timestamp :type: str | None .. py:attribute:: prepared_at :type: str | None .. py:attribute:: training_started_at :type: str | None .. py:attribute:: results_uploaded_at :type: str | None .. py:attribute:: model_config .. py:class:: IBuildImagesForModel Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: files :type: dict .. py:method:: validate_files(v: dict) -> dict .. py:class:: IDetailedModelStatus Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: status :type: flip_api.domain.schemas.status.ModelStatus .. py:attribute:: deleted :type: bool .. py:class:: ILog Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: id :type: uuid.UUID .. py:attribute:: model_id :type: uuid.UUID .. py:attribute:: log_date :type: datetime.datetime .. py:attribute:: success :type: bool .. py:attribute:: trust_name :type: str | None .. py:attribute:: log :type: str .. py:attribute:: model_config .. py:class:: IModelAuditAction Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: model_id :type: uuid.UUID .. py:attribute:: action :type: flip_api.domain.schemas.actions.ModelAuditAction .. py:attribute:: userid :type: str .. py:class:: ITrainingMetricsResponse Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: trust :type: str .. py:attribute:: globalround :type: int .. py:attribute:: label :type: str .. py:attribute:: result :type: float .. py:class:: IModelMetricsValue Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: xValue :type: int .. py:attribute:: yValue :type: float .. py:class:: IModelMetricsData Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: data :type: list[IModelMetricsValue] .. py:attribute:: seriesLabel :type: str .. py:class:: IModelMetrics Bases: :py:obj:`pydantic.BaseModel` .. py:attribute:: yLabel :type: str .. py:attribute:: xLabel :type: str .. py:attribute:: metrics :type: list[IModelMetricsData]