Merge pull request #29 from AmbiqAI/canary

Version 1.5.0
AmbiqAI · Aug 27, 2024 · aa40aed · aa40aed
2 parents 3ce4719 + f106f0f
commit aa40aed
Show file tree

Hide file tree

Showing 156 changed files with 1,913 additions and 1,362 deletions.
diff --git a/docs/api/backends/backend.md b/docs/api/backends/backend.md
diff --git a/docs/api/backends/evb.md b/docs/api/backends/evb.md
diff --git a/docs/api/backends/pc.md b/docs/api/backends/pc.md
diff --git a/docs/api/datasets/augmentation.md b/docs/api/datasets/augmentation.md
diff --git a/docs/api/datasets/dataloader.md b/docs/api/datasets/dataloader.md
diff --git a/docs/api/datasets/dataset.md b/docs/api/datasets/dataset.md
diff --git a/docs/api/datasets/factory.md b/docs/api/datasets/factory.md
diff --git a/docs/api/datasets/icentia11k.md b/docs/api/datasets/icentia11k.md
diff --git a/docs/api/datasets/lsad.md b/docs/api/datasets/lsad.md
diff --git a/docs/api/datasets/ludb.md b/docs/api/datasets/ludb.md
diff --git a/docs/api/datasets/ptbxl.md b/docs/api/datasets/ptbxl.md
diff --git a/docs/api/datasets/qtdb.md b/docs/api/datasets/qtdb.md
diff --git a/docs/api/datasets/synthetic.md b/docs/api/datasets/synthetic.md
diff --git a/docs/api/heartkit.md b/docs/api/heartkit.md
diff --git a/docs/api/index.md b/docs/api/index.md
diff --git a/docs/api/models/factory.md b/docs/api/models/factory.md
diff --git a/docs/api/models/model.md b/docs/api/models/model.md
diff --git a/docs/api/tasks/beat.md b/docs/api/tasks/beat.md
diff --git a/docs/api/tasks/denoise.md b/docs/api/tasks/denoise.md
diff --git a/docs/api/tasks/factory.md b/docs/api/tasks/factory.md
diff --git a/docs/api/tasks/foundation.md b/docs/api/tasks/foundation.md
diff --git a/docs/api/tasks/rhythm.md b/docs/api/tasks/rhythm.md
diff --git a/docs/api/tasks/segmentation.md b/docs/api/tasks/segmentation.md
diff --git a/docs/api/tasks/task.md b/docs/api/tasks/task.md
diff --git a/docs/assets/modes/python-demo-snippet.md b/docs/assets/modes/python-demo-snippet.md
@@ -1,4 +1,4 @@
-```python
+```py linenums="1"
 from pathlib import Path
 import heartkit as hk
 

diff --git a/docs/assets/usage/python-configuration.md b/docs/assets/usage/python-configuration.md
@@ -1,4 +1,4 @@
-```python
+```py linenums="1"
 
 hk.HKTaskParams(
     name="arr-2-eff-sm",

diff --git a/docs/assets/zoo/rhythm/arr-2-eff-sm-cm.html → ...o/arr-2-eff-sm/confusion_matrix_test.html b/docs/assets/zoo/rhythm/arr-2-eff-sm-cm.html → ...o/arr-2-eff-sm/confusion_matrix_test.html
diff --git a/...sets/zoo/rhythm/rhythm-model-zoo-table.md → docs/assets/zoo/arr-2-eff-sm/results.md b/...sets/zoo/rhythm/rhythm-model-zoo-table.md → docs/assets/zoo/arr-2-eff-sm/results.md
@@ -1,4 +1,3 @@
 | NAME             | DATASET                  | FS    | DURATION | # CLASSES | MODEL          | PARAMS | FLOPS   | METRIC   |
 | ---------------- | ------------------------ | ----- | -------- | --------- | -------------- | ------ | ------- | -------- |
 | __ARR-2-EFF-SM__ | Icentia11K, PTB-XL, LSAD | 100Hz | 5s       | 2         | EfficientNetV2 | 18K    |  1.2M   | 99.5% F1 |
-| __ARR-4-EFF-SM__ | LSAD                     | 100Hz | 5s       | 4         | EfficientNetV2 | 27K    |  1.6M   | 95.9% F1 |
diff --git a/docs/assets/zoo/rhythm/arr-4-eff-sm-cm.html → ...o/arr-4-eff-sm/confusion_matrix_test.html b/docs/assets/zoo/rhythm/arr-4-eff-sm-cm.html → ...o/arr-4-eff-sm/confusion_matrix_test.html
diff --git a/docs/assets/zoo/arr-4-eff-sm/results.md b/docs/assets/zoo/arr-4-eff-sm/results.md
@@ -0,0 +1,3 @@
+| NAME             | DATASET                  | FS    | DURATION | # CLASSES | MODEL          | PARAMS | FLOPS   | METRIC   |
+| ---------------- | ------------------------ | ----- | -------- | --------- | -------------- | ------ | ------- | -------- |
+| __ARR-4-EFF-SM__ | LSAD                     | 100Hz | 5s       | 4         | EfficientNetV2 | 27K    |  1.6M   | 95.9% F1 |
diff --git a/docs/assets/zoo/beat/bc-2-eff-sm-cm.html → .../beat-2-eff-sm/confusion_matrix_test.html b/docs/assets/zoo/beat/bc-2-eff-sm-cm.html → .../beat-2-eff-sm/confusion_matrix_test.html
diff --git a/docs/assets/zoo/beat/beat-model-zoo-table.md → docs/assets/zoo/beat-2-eff-sm/results.md b/docs/assets/zoo/beat/beat-model-zoo-table.md → docs/assets/zoo/beat-2-eff-sm/results.md
@@ -1,4 +1,3 @@
 | NAME            | DATASET    | FS    | DURATION | # CLASSES | MODEL          | PARAMS | FLOPS   | METRIC   |
 | --------------- | ---------- | ----- | -------- | --------- | -------------- | ------ | ------- | -------- |
 | __BC-2-EFF-SM__ | Icentia11k | 100Hz | 5s       | 2         | EfficientNetV2 | 28K    | 1.8M    | 97.7% F1 |
-| __BC-3-EFF-SM__ | Icentia11k | 100Hz | 5s       | 3         | EfficientNetV2 | 41K    | 2.1M    | 92.0% F1 |
diff --git a/docs/assets/zoo/beat/bc-3-eff-sm-cm.html → .../beat-3-eff-sm/confusion_matrix_test.html b/docs/assets/zoo/beat/bc-3-eff-sm-cm.html → .../beat-3-eff-sm/confusion_matrix_test.html
diff --git a/docs/assets/zoo/beat-3-eff-sm/results.md b/docs/assets/zoo/beat-3-eff-sm/results.md
@@ -0,0 +1,3 @@
+| NAME            | DATASET    | FS    | DURATION | # CLASSES | MODEL          | PARAMS | FLOPS   | METRIC   |
+| --------------- | ---------- | ----- | -------- | --------- | -------------- | ------ | ------- | -------- |
+| __BC-3-EFF-SM__ | Icentia11k | 100Hz | 5s       | 3         | EfficientNetV2 | 41K    | 2.1M    | 92.0% F1 |
diff --git a/docs/assets/zoo/beat/beat-model-hw-table.md b/docs/assets/zoo/beat/beat-model-hw-table.md
diff --git a/...ts/zoo/denoise/denoise-model-zoo-table.md → docs/assets/zoo/den-ppg-tcn-sm/results.md b/...ts/zoo/denoise/denoise-model-zoo-table.md → docs/assets/zoo/den-ppg-tcn-sm/results.md
@@ -1,5 +1,3 @@
 | NAME                | DATASET           | FS    | DURATION | MODEL          | PARAMS | FLOPS   | METRIC      |
 | ------------------- | ----------------- | ----- | -------- | -------------- | ------ | ------- | ----------- |
-| __DEN-TCN-SM__      | Synthetic, PTB-XL | 100Hz | 2.5s     | TCN            | 3.3K   | 1.0M    | 18.1 SNR    |
-| __DEN-TCN-LG__      | Synthetic, PTB-XL | 100Hz | 2.5s     | TCN            | 6.3K   | 1.8M    | 19.5 SNR    |
 | __DEN-PPG-TCN-SM__  | Synthetic         | 100Hz | 2.5s     | TCN            | 3.5K   | 1.1M    | 92.1% COS   |
diff --git a/docs/assets/zoo/den-tcn-lg/results.md b/docs/assets/zoo/den-tcn-lg/results.md
@@ -0,0 +1,3 @@
+| NAME                | DATASET           | FS    | DURATION | MODEL          | PARAMS | FLOPS   | METRIC      |
+| ------------------- | ----------------- | ----- | -------- | -------------- | ------ | ------- | ----------- |
+| __DEN-TCN-LG__      | Synthetic, PTB-XL | 100Hz | 2.5s     | TCN            | 6.3K   | 1.8M    | 19.5 SNR    |
diff --git a/docs/assets/zoo/den-tcn-sm/results.md b/docs/assets/zoo/den-tcn-sm/results.md
@@ -0,0 +1,3 @@
+| NAME                | DATASET           | FS    | DURATION | MODEL          | PARAMS | FLOPS   | METRIC      |
+| ------------------- | ----------------- | ----- | -------- | -------------- | ------ | ------- | ----------- |
+| __DEN-TCN-SM__      | Synthetic, PTB-XL | 100Hz | 2.5s     | TCN            | 3.3K   | 1.0M    | 18.1 SNR    |
diff --git a/docs/assets/zoo/denoise/denoise-model-hw-table.md b/docs/assets/zoo/denoise/denoise-model-hw-table.md
diff --git a/docs/assets/zoo/diagnostic/diagnostic-model-hw-table.md b/docs/assets/zoo/diagnostic/diagnostic-model-hw-table.md
diff --git a/.../diagnostic/diagnostic-model-zoo-table.md → docs/assets/zoo/diagnostic/results.md b/.../diagnostic/diagnostic-model-zoo-table.md → docs/assets/zoo/diagnostic/results.md
diff --git a/docs/assets/zoo/rhythm/rhythm-model-hw-table.md b/docs/assets/zoo/rhythm/rhythm-model-hw-table.md
diff --git a/...ets/zoo/segmentation/seg-2-tcn-sm-cm.html → ...o/seg-2-tcn-sm/confusion_matrix_test.html b/...ets/zoo/segmentation/seg-2-tcn-sm-cm.html → ...o/seg-2-tcn-sm/confusion_matrix_test.html
diff --git a/...mentation/segmentation-model-zoo-table.md → docs/assets/zoo/seg-2-tcn-sm/results.md b/...mentation/segmentation-model-zoo-table.md → docs/assets/zoo/seg-2-tcn-sm/results.md
@@ -1,5 +1,3 @@
 | NAME             | DATASET                  | FS    | DURATION | # CLASSES | MODEL         | PARAMS | FLOPS   | METRIC    |
 | ---------------- | ------------------------ | ----- | -------- | --------- | ------------- | ------ | ------- | --------- |
 | __SEG-2-TCN-SM__ | LUDB, Synthetic          | 100Hz | 2.5s     | 2         | TCN           | 2K     | 0.42M   | 96.6% F1  |
-| __SEG-4-TCN-SM__ | LUDB, Synthetic          | 100Hz | 2.5s     | 4         | TCN           | 7K     | 2.1M    | 86.3% F1  |
-| __SEG-4-TCN-LG__ | LUDB, Synthetic          | 100Hz | 2.5s     | 4         | TCN           | 10K    | 3.9M    | 89.4% F1  |
diff --git a/...ets/zoo/segmentation/seg-4-tcn-lg-cm.html → ...o/seg-4-tcn-lg/confusion_matrix_test.html b/...ets/zoo/segmentation/seg-4-tcn-lg-cm.html → ...o/seg-4-tcn-lg/confusion_matrix_test.html
diff --git a/docs/assets/zoo/seg-4-tcn-lg/results.md b/docs/assets/zoo/seg-4-tcn-lg/results.md
@@ -0,0 +1,3 @@
+| NAME             | DATASET                  | FS    | DURATION | # CLASSES | MODEL         | PARAMS | FLOPS   | METRIC    |
+| ---------------- | ------------------------ | ----- | -------- | --------- | ------------- | ------ | ------- | --------- |
+| __SEG-4-TCN-LG__ | LUDB, Synthetic          | 100Hz | 2.5s     | 4         | TCN           | 10K    | 3.9M    | 89.4% F1  |
diff --git a/...ets/zoo/segmentation/seg-4-tcn-sm-cm.html → ...o/seg-4-tcn-sm/confusion_matrix_test.html b/...ets/zoo/segmentation/seg-4-tcn-sm-cm.html → ...o/seg-4-tcn-sm/confusion_matrix_test.html
diff --git a/docs/assets/zoo/seg-4-tcn-sm/results.md b/docs/assets/zoo/seg-4-tcn-sm/results.md
@@ -0,0 +1,3 @@
+| NAME             | DATASET                  | FS    | DURATION | # CLASSES | MODEL         | PARAMS | FLOPS   | METRIC    |
+| ---------------- | ------------------------ | ----- | -------- | --------- | ------------- | ------ | ------- | --------- |
+| __SEG-4-TCN-SM__ | LUDB, Synthetic          | 100Hz | 2.5s     | 4         | TCN           | 7K     | 2.1M    | 86.3% F1  |