:py:mod:`rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass` ================================================================================== .. py:module:: rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.AnalyticsVisibility rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.DataSheetComposition rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.DataSheet rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.DifferentialPrivacy rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.PrivacySettings rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.FederatedDatasetCreateInput rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.FederatedDataset .. py:class:: AnalyticsVisibility Bases: :py:obj:`str`, :py:obj:`enum.Enum` Supported values for FederatedDataset.analytics_visibility. .. !! processed by numpydoc !! .. py:attribute:: PUBLIC :value: 'Public' .. py:attribute:: LIMITED :value: 'Limited' .. py:class:: DataSheetComposition(**data: Any) Bases: :py:obj:`pydantic.BaseModel` Describe the General composition of the dataset .. !! processed by numpydoc !! .. py:attribute:: geography :type: Optional[str] Describe the geographic regions represented in this dataset .. !! processed by numpydoc !! .. py:attribute:: data_type :type: Optional[str] Describe the data types represented in this dataset .. !! processed by numpydoc !! .. py:attribute:: modality :type: Optional[str] Describe the modalities represented in this dataset .. !! processed by numpydoc !! .. py:attribute:: disease_group :type: Optional[str] Describe the disease areas represented in this dataset .. !! processed by numpydoc !! .. py:attribute:: body_part :type: Optional[str] Describe the body parts represented in this dataset .. !! processed by numpydoc !! .. py:class:: DataSheet(**data: Any) Bases: :py:obj:`pydantic.BaseModel` A standard description of the data to aid users of the data to understand your dataset. See https://arxiv.org/abs/1803.09010 .. !! processed by numpydoc !! .. py:attribute:: name :type: Optional[str] Name for the dataset .. !! processed by numpydoc !! .. py:attribute:: motivation :type: Optional[str] Describe the motivation for building this dataset .. !! processed by numpydoc !! .. py:attribute:: composition :type: Optional[DataSheetComposition] Describe the General composition of the dataset .. !! processed by numpydoc !! .. py:attribute:: collection_process :type: Optional[str] Describe the data collection processes used in the creation of this dataset. .. !! processed by numpydoc !! .. py:attribute:: preprocessing :type: Optional[str] Describe any preprocessing/cleaning/labeling performed in the preparation of the dataset. .. !! processed by numpydoc !! .. py:attribute:: uses :type: Optional[str] Has the dataset been used for any tasks already? .. !! processed by numpydoc !! .. py:attribute:: distribution :type: Optional[str] Describe distribution considerations for this dataset, if any .. !! processed by numpydoc !! .. py:attribute:: maintenance :type: Optional[str] Describe the maintenance plan for this dataset. .. !! processed by numpydoc !! .. py:class:: DifferentialPrivacy Bases: :py:obj:`int`, :py:obj:`enum.Enum` Differential privacy level .. !! processed by numpydoc !! .. py:attribute:: NONE :value: 0 .. py:attribute:: LOW :value: 1 .. py:attribute:: MEDIUM :value: 2 .. py:attribute:: HIGH :value: 3 .. py:class:: PrivacySettings(**data) Bases: :py:obj:`rhino_health.lib.dataclass.RhinoBaseModel` Privacy Settings for your Dataset .. !! processed by numpydoc !! .. py:attribute:: k_anonymization_parameter :type: pydantic.NonNegativeInt The minimal number of data points required to provide metric response values .. !! processed by numpydoc !! .. py:attribute:: differential_privacy_setting :type: DifferentialPrivacy The level at which to enforce differential privacy .. !! processed by numpydoc !! .. py:class:: FederatedDatasetCreateInput(**kwargs) Bases: :py:obj:`FederatedDatasetBase` Input for creating a new Federated Dataset :Parameters: **datasets: Optional[List[Dataset]]** A list of Dataset Dataclasses, use in place of dataset_uids **primary_workgroup: Optional[Workgroup]** A workgroup Dataclass, use in place of primary_workgroup_uid .. rubric:: Examples >>> FederatedDatasetCreateInput( ... name="My Federated Dataset", ... datasets=datasets, ... datasheet=json.dumps(datasheet), ... analytics_visibility="Limited", ... privacy_settings=json.dumps(privacy_settings), ... primary_workgroup=project.primary_workgroup, ... ) .. !! processed by numpydoc !! .. py:attribute:: name :type: str The name of the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: base_version_uid :type: Optional[str] If this Federated Dataset is a new version of another Federated Dataset, the original Unique ID of the base Federated Dataset. .. !! processed by numpydoc !! .. py:attribute:: dataset_uids :type: typing_extensions.Annotated[List[str], Field(alias='datasets')] A list of UIDs of the Datasets comprising the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: datasheet :type: DataSheet Datasheet for the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: analytics_visibility :type: AnalyticsVisibility The visibility mode for Federated Dataset's Dataset' analytics ("Public" or "Limited") .. !! processed by numpydoc !! .. py:attribute:: privacy_settings :type: PrivacySettings Privacy settings for the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: primary_workgroup_uid :type: typing_extensions.Annotated[str, Field(alias='primary_workgroup')] The unique ID of the Federated Dataset's primary Workgroup .. !! processed by numpydoc !! .. py:attribute:: contact_email :type: Optional[str] Email address to use to contact the owners of the Federated Dataset .. !! processed by numpydoc !! .. py:class:: FederatedDataset(**data) A Federated Dataset existing on the platform .. !! processed by numpydoc !! .. py:property:: datasets :type: List[Dataset] Return the Dataset Dataclasses associated with dataset_uids .. warning:: The result of this function is cached. Be careful calling this function after making changes. All dataclasses must already exist on the platform before making this call. :Returns: datasets: List[Dataset] Dataclasses representing the Dataset .. py:property:: primary_workgroup :type: Workgroup Return the Workgroup Dataclass associated with primary_workgroup_uid .. warning:: The result of this function is cached. Be careful calling this function after making changes. All dataclasses must already exist on the platform before making this call. :Returns: primary_workgroup: Workgroup Dataclass representing the Workgroup .. py:property:: creator :type: User Return the User Dataclass associated with creator_uid .. warning:: The result of this function is cached. Be careful calling this function after making changes. All dataclasses must already exist on the platform before making this call. :Returns: creator: User Dataclass representing the User .. py:attribute:: uid :type: str The Unique ID of the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: dataset_uids :type: List[str] A list of Datasets comprising the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: name :type: str The name of the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: base_version_uid :type: Optional[str] If this Federated Dataset is a new version of another Federated Dataset, the original Unique ID of the base Federated Dataset. .. !! processed by numpydoc !! .. py:attribute:: datasheet :type: DataSheet Datasheet for the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: analytics_visibility :type: AnalyticsVisibility The visibility mode for Federated Dataset's Dataset' analytics ("Public" or "Limited") .. !! processed by numpydoc !! .. py:attribute:: privacy_settings :type: PrivacySettings Privacy settings for the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: contact_email :type: Optional[str] Email address to use to contact the owners of the Federated Dataset .. !! processed by numpydoc !! .. py:attribute:: creator_uid :type: str The UID of the creator of this dataclass on the system .. !! processed by numpydoc !! .. py:attribute:: created_at :type: str When this dataclass was created on the system .. !! processed by numpydoc !! .. py:attribute:: dataset_names :type: List[str] The dataset names .. py:attribute:: primary_workgroup_name :type: str The primary_workgroup name .. py:attribute:: creator_name :type: str The creator name