Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/api/datasets/pyhealth.datasets.DREAMTDataset.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
pyhealth.datasets.DREAMTDataset
===================================

The Dataset for Real-time sleep stage EstimAtion using Multisensor wearable Technology (DREAMT) includes wrist-based wearable and polysomnography (PSG) sleep data from 100 participants recruited from the Duke University Health System (DUHS) Sleep Disorder Lab.
The Dataset for Real-time sleep stage EstimAtion using Multisensor wearable
Technology (DREAMT) includes wrist-based wearable and polysomnography (PSG)
sleep data from 100 participants recruited from the Duke University Health
System (DUHS) Sleep Disorder Lab.

This includes wearable signals, PSG signals, sleep labels, and clinical data related to sleep health and disorders.
This includes wearable signals, PSG signals, sleep labels, and clinical data
related to sleep health and disorders.

The DREAMTDataset class provides an interface for loading and working with the DREAMT dataset. It can process DREAMT data across versions into a well-structured dataset object providing support for modeling and analysis.
``DREAMTDataset`` supports both official DREAMT release layouts and partial
local subsets. It builds metadata linking each patient to locally available
signal files and exposes data for both the simplified
``SleepStagingDREAMT`` window-classification task and the more sequence-style
``SleepStagingDREAMTSeq`` task.

Refer to the `doc <https://physionet.org/content/dreamt/>`_ for more information about the dataset.
Refer to the `doc <https://physionet.org/content/dreamt/>`_ for more
information about the dataset.

.. autoclass:: pyhealth.datasets.DREAMTDataset
:members:
:undoc-members:
:show-inheritance:






1 change: 1 addition & 0 deletions docs/api/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ API Reference
models/pyhealth.models.SparcNet
models/pyhealth.models.StageNet
models/pyhealth.models.StageAttentionNet
models/pyhealth.models.WatchSleepNet
models/pyhealth.models.AdaCare
models/pyhealth.models.ConCare
models/pyhealth.models.Agent
Expand Down
14 changes: 14 additions & 0 deletions docs/api/models/pyhealth.models.WatchSleepNet.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
pyhealth.models.WatchSleepNet
===================================

Simplified WatchSleepNet-style architecture for wearable sleep staging.

The implementation supports both:

- pooled classification over fixed windows
- sequence-output classification for epoch-level sleep staging

.. autoclass:: pyhealth.models.WatchSleepNet
:members:
:undoc-members:
:show-inheritance:
15 changes: 14 additions & 1 deletion docs/api/tasks/pyhealth.tasks.sleep_staging.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
pyhealth.tasks.sleep_staging
=======================================

``SleepStagingDREAMT`` provides a simplified window-classification task, while
``SleepStagingDREAMTSeq`` provides a more paper-aligned sequence-style task.

.. autoclass:: pyhealth.tasks.SleepStagingDREAMT
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: pyhealth.tasks.SleepStagingDREAMTSeq
:members:
:undoc-members:
:show-inheritance:

.. autofunction:: pyhealth.tasks.sleep_staging.sleep_staging_isruc_fn
.. autofunction:: pyhealth.tasks.sleep_staging.sleep_staging_sleepedf_fn
.. autofunction:: pyhealth.tasks.sleep_staging.sleep_staging_shhs_fn
.. autofunction:: pyhealth.tasks.sleep_staging.sleep_staging_shhs_fn
Loading