Skip to content

Commit 0873ec8

Browse files
jhnwu3John Wu
jhnwu3
and
John Wu
authored
Add/processor docs (#549)
* docs for processors in place * add processors to the main page --------- The docs pipeline is broken so I basically just merge to see if readthedocs will build it properly. Co-authored-by: John Wu <johnwu3@sunlab-work-01.cs.illinois.edu>
1 parent 5628b66 commit 0873ec8

17 files changed

Lines changed: 160 additions & 0 deletions

‎docs/api/processors.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Processors
2+
===============
3+
4+
We implement the following processors for supporting data preprocessing and tokenization into tensors in multiple healthcare predictive tasks.
5+
6+
7+
.. toctree::
8+
:maxdepth: 3
9+
10+
processors/pyhealth.processors.Processor
11+
processors/pyhealth.processors.FeatureProcessor
12+
processors/pyhealth.processors.SampleProcessor
13+
processors/pyhealth.processors.DatasetProcessor
14+
processors/pyhealth.processors.ImageProcessor
15+
processors/pyhealth.processors.SequenceProcessor
16+
processors/pyhealth.processors.TensorProcessor
17+
processors/pyhealth.processors.TimeseriesProcessor
18+
processors/pyhealth.processors.SignalProcessor
19+
processors/pyhealth.processors.BinaryLabelProcessor
20+
processors/pyhealth.processors.MultiClassLabelProcessor
21+
processors/pyhealth.processors.MultiLabelProcessor
22+
processors/pyhealth.processors.RegressionLabelProcessor
23+
processors/pyhealth.processors.RawProcessor
24+
processors/pyhealth.processors.TextProcessor

‎docs/api/processors/pyhealth.processors.BinaryLabelProcessor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.BinaryLabelProcessor
2+
===================================
3+
4+
Processor for binary label data.
5+
6+
.. autoclass:: pyhealth.processors.BinaryLabelProcessor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/api/processors/pyhealth.processors.DatasetProcessor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.DatasetProcessor
2+
===================================
3+
4+
The base class for dataset processors.
5+
6+
.. autoclass:: pyhealth.processors.DatasetProcessor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/api/processors/pyhealth.processors.FeatureProcessor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.FeatureProcessor
2+
===================================
3+
4+
The base class for feature processors.
5+
6+
.. autoclass:: pyhealth.processors.FeatureProcessor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/api/processors/pyhealth.processors.ImageProcessor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.ImageProcessor
2+
===================================
3+
4+
Processor for image data.
5+
6+
.. autoclass:: pyhealth.processors.ImageProcessor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/api/processors/pyhealth.processors.MultiClassLabelProcessor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.MultiClassLabelProcessor
2+
===================================
3+
4+
Processor for multi-class label data.
5+
6+
.. autoclass:: pyhealth.processors.MultiClassLabelProcessor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/api/processors/pyhealth.processors.MultiLabelProcessor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.MultiLabelProcessor
2+
===================================
3+
4+
Processor for multi-label data.
5+
6+
.. autoclass:: pyhealth.processors.MultiLabelProcessor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/api/processors/pyhealth.processors.Processor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.Processor
2+
===================================
3+
4+
The base class for all processors.
5+
6+
.. autoclass:: pyhealth.processors.Processor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/api/processors/pyhealth.processors.RawProcessor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.RawProcessor
2+
===================================
3+
4+
Processor for raw data.
5+
6+
.. autoclass:: pyhealth.processors.RawProcessor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/api/processors/pyhealth.processors.RegressionLabelProcessor.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pyhealth.processors.RegressionLabelProcessor
2+
===================================
3+
4+
Processor for regression label data.
5+
6+
.. autoclass:: pyhealth.processors.RegressionLabelProcessor
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

0 commit comments

Comments
 (0)