Skip to main content

Official Python package for the CARE multimodal clinical dataset.

Project description

care-dataset

care-dataset is the official Python package for accessing and managing the CARE multimodal clinical dataset.

The package provides a high-level interface for loading CARE from Hugging Face, filtering participants using metadata, selecting modalities, creating profile-level train/test and cross-validation splits, and preventing profile leakage in machine learning experiments.

Installation

The package requires Python 3.11 or newer.

Install the package either directly from PyPI:

pip install care-dataset

or by cloning the source repository:

git clone https://gitlab.inesc-id.pt/hlt/public/datasets/multimodal_care.git
cd multimodal_care
pip install .

Quick start

from care_dataset import CAREDataset

care = CAREDataset()

care.info()

Filter the dataset

dataset = care.filter(
    label_id__in=["CONTROL", "PARKINSON"],
)

Select one or more modalities

dataset = dataset.select_modalities(
    "egemaps_func",
)

Create a profile-level cross-validation split

cv_iters, report = dataset.cross_validation(
    k=5,
    keep_duplicate_profiles=False,
    report=True,
)

report.info()

CARE dataset

The CARE dataset, documentation, feature archives, and usage examples are available from the official Hugging Face Dataset repository:

https://huggingface.co/datasets/inesc-id/multimodal_care

License

This package is distributed under the MIT License.

The CARE dataset itself is distributed separately under the CARE Data Use Agreement (DUA).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

care_dataset-0.1.0.tar.gz (73.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

care_dataset-0.1.0-py3-none-any.whl (74.4 kB view details)

Uploaded Python 3

File details

Details for the file care_dataset-0.1.0.tar.gz.

File metadata

  • Download URL: care_dataset-0.1.0.tar.gz
  • Upload date:
  • Size: 73.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for care_dataset-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ff90bfe90f189786bd6f4e6f8cd90ffcf7c00c275f9553f5905bfd979fe57f3b
MD5 39f62eb8bab47e7b2a78d95e817f78be
BLAKE2b-256 3e277e97fe2277fb64adb4d749a3583b6b68c8b201157801546e2743ec822ae7

See more details on using hashes here.

File details

Details for the file care_dataset-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: care_dataset-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 74.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for care_dataset-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b6085533b8bcd54bbe83fe2e166b916fb3e1d00c05570d0e1a5029b38cf4a029
MD5 d9758fe0f350e2fecb65558a909fe7e7
BLAKE2b-256 7a958dc44f9013cc92a348aa02af165053b927e3e1beadff57b6451bf4459d9b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page