Skip to content

Commit

Permalink
Removed one header to align doc numbering
Browse files Browse the repository at this point in the history
  • Loading branch information
@rgerkin
rgerkin committed Jun 21, 2021
1 parent 61f1975 commit 5a9312d
Show file tree
Hide file tree
Showing 6 changed files with 224 additions and 169 deletions.
6 changes: 3 additions & 3 deletions docs/chapter1.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
"source": [
"![SciUnit Logo](https://raw.githubusercontent.com/scidash/assets/master/logos/SciUnit/sci-unit-tag.png)\n",
"\n",
"# SciUnit is a framework for validating scientific models by creating experimental-data-driven unit tests. \n",
"\n",
"<a href=\"https://colab.research.google.com/github/scidash/sciunit/blob/master/docs/chapter1.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
"\n",
"# Chapter 1. What is SciUnit?\n",
"Everyone hopes that their model has some correspondence with reality. Usually, checking whether this is true is done informally.\n",
"### SciUnit makes this formal and transparent. "
"### SciUnit makes this formal and transparent.\n",
"SciUnit is a framework for validating scientific models by creating experimental-data-driven unit tests. "
]
},
{
Expand Down Expand Up @@ -244,7 +244,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.3"
"version": "3.9.4"
}
},
"nbformat": 4,
Expand Down
122 changes: 60 additions & 62 deletions docs/chapter2.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
"source": [
"![SciUnit Logo](https://raw.githubusercontent.com/scidash/assets/master/logos/SciUnit/sci-unit-tag.png)\n",
"\n",
"# SciUnit is a framework for validating scientific models by creating experimental-data-driven unit tests. \n",
"\n",
"<a href=\"https://colab.research.google.com/github/scidash/sciunit/blob/master/docs/chapter2.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
"\n",
"# Chapter 2. Writing a `model` and `test` in SciUnit from scratch\n",
Expand All @@ -23,7 +21,7 @@
},
{
"cell_type": "code",
"execution_count": 19,
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -32,7 +30,7 @@
},
{
"cell_type": "code",
"execution_count": 20,
"execution_count": 2,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -49,7 +47,7 @@
},
{
"cell_type": "code",
"execution_count": 21,
"execution_count": 3,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -71,7 +69,7 @@
},
{
"cell_type": "code",
"execution_count": 22,
"execution_count": 4,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -80,7 +78,7 @@
},
{
"cell_type": "code",
"execution_count": 23,
"execution_count": 5,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -106,7 +104,7 @@
},
{
"cell_type": "code",
"execution_count": 24,
"execution_count": 6,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -135,7 +133,7 @@
},
{
"cell_type": "code",
"execution_count": 26,
"execution_count": 8,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -165,7 +163,7 @@
},
{
"cell_type": "code",
"execution_count": 27,
"execution_count": 9,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -187,7 +185,7 @@
},
{
"cell_type": "code",
"execution_count": 28,
"execution_count": 10,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -196,7 +194,7 @@
},
{
"cell_type": "code",
"execution_count": 29,
"execution_count": 11,
"metadata": {},
"outputs": [
{
Expand All @@ -205,7 +203,7 @@
"Pass"
]
},
"execution_count": 29,
"execution_count": 11,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -224,7 +222,7 @@
},
{
"cell_type": "code",
"execution_count": 30,
"execution_count": 12,
"metadata": {},
"outputs": [
{
Expand All @@ -233,7 +231,7 @@
"Pass"
]
},
"execution_count": 30,
"execution_count": 12,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -251,7 +249,7 @@
},
{
"cell_type": "code",
"execution_count": 31,
"execution_count": 13,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -267,7 +265,7 @@
},
{
"cell_type": "code",
"execution_count": 32,
"execution_count": 14,
"metadata": {},
"outputs": [
{
Expand All @@ -276,7 +274,7 @@
"'Passing score if the prediction equals the observation'"
]
},
"execution_count": 32,
"execution_count": 14,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -295,7 +293,7 @@
},
{
"cell_type": "code",
"execution_count": 33,
"execution_count": 15,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -314,36 +312,36 @@
},
{
"cell_type": "code",
"execution_count": 34,
"execution_count": 16,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 37 on =1\u001b[49m\u001b[39m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 37 on =2\u001b[49m\u001b[39m\n",
"\u001b[38;2;60;169;88m\u001b[48;2;50;50;50mScore: Pass for Constant Model 37 on =37\u001b[49m\u001b[39m\n"
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 37 on =1\u001b[0m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 37 on =2\u001b[0m\n",
"\u001b[38;2;60;169;88m\u001b[48;2;50;50;50mScore: Pass for Constant Model 37 on =37\u001b[0m\n"
]
},
{
"data": {
"text/html": [
"<style type=\"text/css\" >\n",
"#T_d2bab0a0_ace6_11eb_a71a_ac1f6b647d9arow0_col0,#T_d2bab0a0_ace6_11eb_a71a_ac1f6b647d9arow0_col1{\n",
"#T_8d293_row0_col0,#T_8d293_row0_col1{\n",
" background-color: rgb(50, 50, 50);\n",
" color: rgb(230, 78, 52);\n",
" text-align: center;\n",
" }#T_d2bab0a0_ace6_11eb_a71a_ac1f6b647d9arow0_col2{\n",
" }#T_8d293_row0_col2{\n",
" background-color: rgb(50, 50, 50);\n",
" color: rgb(60, 169, 88);\n",
" text-align: center;\n",
" }</style><table id=\"T_d2bab0a0_ace6_11eb_a71a_ac1f6b647d9a\" ><thead> <tr> <th class=\"blank level0\" ></th> <th class=\"col_heading level0 col0\" >=1</th> <th class=\"col_heading level0 col1\" >=2</th> <th class=\"col_heading level0 col2\" >=37</th> </tr></thead><tbody>\n",
" }</style><table id=\"T_8d293_\" ><thead> <tr> <th class=\"blank level0\" ></th> <th class=\"col_heading level0 col0\" >=1</th> <th class=\"col_heading level0 col1\" >=2</th> <th class=\"col_heading level0 col2\" >=37</th> </tr></thead><tbody>\n",
" <tr>\n",
" <th id=\"T_d2bab0a0_ace6_11eb_a71a_ac1f6b647d9alevel0_row0\" class=\"row_heading level0 row0\" >Constant Model 37</th>\n",
" <td id=\"T_d2bab0a0_ace6_11eb_a71a_ac1f6b647d9arow0_col0\" class=\"data row0 col0\" >Fail</td>\n",
" <td id=\"T_d2bab0a0_ace6_11eb_a71a_ac1f6b647d9arow0_col1\" class=\"data row0 col1\" >Fail</td>\n",
" <td id=\"T_d2bab0a0_ace6_11eb_a71a_ac1f6b647d9arow0_col2\" class=\"data row0 col2\" >Pass</td>\n",
" <th id=\"T_8d293_level0_row0\" class=\"row_heading level0 row0\" >Constant Model 37</th>\n",
" <td id=\"T_8d293_row0_col0\" class=\"data row0 col0\" >Fail</td>\n",
" <td id=\"T_8d293_row0_col1\" class=\"data row0 col1\" >Fail</td>\n",
" <td id=\"T_8d293_row0_col2\" class=\"data row0 col2\" >Pass</td>\n",
" </tr>\n",
" </tbody></table>"
],
Expand All @@ -352,7 +350,7 @@
"Constant Model 37 Fail Fail Pass"
]
},
"execution_count": 34,
"execution_count": 16,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -371,54 +369,54 @@
},
{
"cell_type": "code",
"execution_count": 35,
"execution_count": 17,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"\u001b[38;2;60;169;88m\u001b[48;2;50;50;50mScore: Pass for Constant Model 1 on =1\u001b[49m\u001b[39m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 1 on =2\u001b[49m\u001b[39m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 1 on =37\u001b[49m\u001b[39m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 2 on =1\u001b[49m\u001b[39m\n",
"\u001b[38;2;60;169;88m\u001b[48;2;50;50;50mScore: Pass for Constant Model 2 on =2\u001b[49m\u001b[39m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 2 on =37\u001b[49m\u001b[39m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 37 on =1\u001b[49m\u001b[39m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 37 on =2\u001b[49m\u001b[39m\n",
"\u001b[38;2;60;169;88m\u001b[48;2;50;50;50mScore: Pass for Constant Model 37 on =37\u001b[49m\u001b[39m\n"
"\u001b[38;2;60;169;88m\u001b[48;2;50;50;50mScore: Pass for Constant Model 1 on =1\u001b[0m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 1 on =2\u001b[0m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 1 on =37\u001b[0m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 2 on =1\u001b[0m\n",
"\u001b[38;2;60;169;88m\u001b[48;2;50;50;50mScore: Pass for Constant Model 2 on =2\u001b[0m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 2 on =37\u001b[0m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 37 on =1\u001b[0m\n",
"\u001b[38;2;230;78;52m\u001b[48;2;50;50;50mScore: Fail for Constant Model 37 on =2\u001b[0m\n",
"\u001b[38;2;60;169;88m\u001b[48;2;50;50;50mScore: Pass for Constant Model 37 on =37\u001b[0m\n"
]
},
{
"data": {
"text/html": [
"<style type=\"text/css\" >\n",
"#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow0_col0,#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow1_col1,#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow2_col2{\n",
"#T_86788_row0_col0,#T_86788_row1_col1,#T_86788_row2_col2{\n",
" background-color: rgb(50, 50, 50);\n",
" color: rgb(60, 169, 88);\n",
" text-align: center;\n",
" }#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow0_col1,#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow0_col2,#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow1_col0,#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow1_col2,#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow2_col0,#T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow2_col1{\n",
" }#T_86788_row0_col1,#T_86788_row0_col2,#T_86788_row1_col0,#T_86788_row1_col2,#T_86788_row2_col0,#T_86788_row2_col1{\n",
" background-color: rgb(50, 50, 50);\n",
" color: rgb(230, 78, 52);\n",
" text-align: center;\n",
" }</style><table id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9a\" ><thead> <tr> <th class=\"blank level0\" ></th> <th class=\"col_heading level0 col0\" >=1</th> <th class=\"col_heading level0 col1\" >=2</th> <th class=\"col_heading level0 col2\" >=37</th> </tr></thead><tbody>\n",
" }</style><table id=\"T_86788_\" ><thead> <tr> <th class=\"blank level0\" ></th> <th class=\"col_heading level0 col0\" >=1</th> <th class=\"col_heading level0 col1\" >=2</th> <th class=\"col_heading level0 col2\" >=37</th> </tr></thead><tbody>\n",
" <tr>\n",
" <th id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9alevel0_row0\" class=\"row_heading level0 row0\" >Constant Model 1</th>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow0_col0\" class=\"data row0 col0\" >Pass</td>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow0_col1\" class=\"data row0 col1\" >Fail</td>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow0_col2\" class=\"data row0 col2\" >Fail</td>\n",
" <th id=\"T_86788_level0_row0\" class=\"row_heading level0 row0\" >Constant Model 1</th>\n",
" <td id=\"T_86788_row0_col0\" class=\"data row0 col0\" >Pass</td>\n",
" <td id=\"T_86788_row0_col1\" class=\"data row0 col1\" >Fail</td>\n",
" <td id=\"T_86788_row0_col2\" class=\"data row0 col2\" >Fail</td>\n",
" </tr>\n",
" <tr>\n",
" <th id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9alevel0_row1\" class=\"row_heading level0 row1\" >Constant Model 2</th>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow1_col0\" class=\"data row1 col0\" >Fail</td>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow1_col1\" class=\"data row1 col1\" >Pass</td>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow1_col2\" class=\"data row1 col2\" >Fail</td>\n",
" <th id=\"T_86788_level0_row1\" class=\"row_heading level0 row1\" >Constant Model 2</th>\n",
" <td id=\"T_86788_row1_col0\" class=\"data row1 col0\" >Fail</td>\n",
" <td id=\"T_86788_row1_col1\" class=\"data row1 col1\" >Pass</td>\n",
" <td id=\"T_86788_row1_col2\" class=\"data row1 col2\" >Fail</td>\n",
" </tr>\n",
" <tr>\n",
" <th id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9alevel0_row2\" class=\"row_heading level0 row2\" >Constant Model 37</th>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow2_col0\" class=\"data row2 col0\" >Fail</td>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow2_col1\" class=\"data row2 col1\" >Fail</td>\n",
" <td id=\"T_ebc7ad5a_ace6_11eb_a71a_ac1f6b647d9arow2_col2\" class=\"data row2 col2\" >Pass</td>\n",
" <th id=\"T_86788_level0_row2\" class=\"row_heading level0 row2\" >Constant Model 37</th>\n",
" <td id=\"T_86788_row2_col0\" class=\"data row2 col0\" >Fail</td>\n",
" <td id=\"T_86788_row2_col1\" class=\"data row2 col1\" >Fail</td>\n",
" <td id=\"T_86788_row2_col2\" class=\"data row2 col2\" >Pass</td>\n",
" </tr>\n",
" </tbody></table>"
],
Expand All @@ -429,7 +427,7 @@
"Constant Model 37 Fail Fail Pass"
]
},
"execution_count": 35,
"execution_count": 17,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -450,7 +448,7 @@
},
{
"cell_type": "code",
"execution_count": 36,
"execution_count": 18,
"metadata": {},
"outputs": [
{
Expand All @@ -462,7 +460,7 @@
"Name: =1, dtype: object"
]
},
"execution_count": 36,
"execution_count": 18,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -480,7 +478,7 @@
},
{
"cell_type": "code",
"execution_count": 37,
"execution_count": 19,
"metadata": {},
"outputs": [
{
Expand All @@ -492,7 +490,7 @@
"Name: Constant Model 2, dtype: object"
]
},
"execution_count": 37,
"execution_count": 19,
"metadata": {},
"output_type": "execute_result"
}
Expand Down Expand Up @@ -526,7 +524,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.3"
"version": "3.9.4"
}
},
"nbformat": 4,
Expand Down
4 changes: 1 addition & 3 deletions docs/chapter3.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
"source": [
"![SciUnit Logo](https://raw.githubusercontent.com/scidash/assets/master/logos/SciUnit/sci-unit-tag.png)\n",
"\n",
"# SciUnit is a framework for validating scientific models by creating experimental-data-driven unit tests. \n",
"\n",
"<a href=\"https://colab.research.google.com/github/scidash/sciunit/blob/master/docs/chapter3.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
"\n",
"# Chapter 3. Testing with help from the SciUnit standard library\n",
Expand Down Expand Up @@ -189,7 +187,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.3"
"version": "3.9.4"
}
},
"nbformat": 4,
Expand Down

0 comments on commit 5a9312d

Please sign in to comment.