Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add multi-categorical tutorial #151

Merged
merged 3 commits into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ See the full documentation [here](noaa-owp.github.io/gval/).

WARNING:

- Our current public API and output formats are likely to change in
the future.
- Software is provided "AS-IS" without any guarantees. Please QA/QC
your metrics carefully until this project matures.
- Our current public API and output formats are likely to change in the
future.
- Software is provided "AS-IS" without any guarantees. Please QA/QC your
metrics carefully until this project matures.

# Installation

Expand Down
5 changes: 5 additions & 0 deletions docs/compile_readme_and_arrange_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ def compile_readme():
f"{abs_path}/sphinx/SphinxContinuousTutorial.ipynb",
)

shutil.copy(
f"{abs_path}/../notebooks/Multi-Class Categorical Statistics.ipynb",
f"{abs_path}/sphinx/SphinxMulticatTutorial.ipynb",
)

shutil.copy(
f"{abs_path}/../CONTRIBUTING.MD",
f"{abs_path}/sphinx/SPHINX_CONTRIBUTING.MD",
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/PYPI_README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ See the full documentation [here](noaa-owp.github.io/gval/).

WARNING:

- Our current public API and output formats are likely to change in
the future.
- Software is provided "AS-IS" without any guarantees. Please QA/QC
your metrics carefully until this project matures.
- Our current public API and output formats are likely to change in the
future.
- Software is provided "AS-IS" without any guarantees. Please QA/QC your
metrics carefully until this project matures.

# Installation

Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/SPHINX_README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ continuous, and probabilistic.

WARNING:

- Our current public API and output formats are likely to change in
the future.
- Software is provided "AS-IS" without any guarantees. Please QA/QC
your metrics carefully until this project matures.
- Our current public API and output formats are likely to change in the
future.
- Software is provided "AS-IS" without any guarantees. Please QA/QC your
metrics carefully until this project matures.

# Installation

Expand Down
1,158 changes: 1,158 additions & 0 deletions docs/sphinx/SphinxMulticatTutorial.ipynb

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/sphinx/SphinxTutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"id": "a403ee30",
"metadata": {},
"source": [
"# Categorical Comparisons"
"# Two-Class Categorical Comparisons"
]
},
{
Expand Down Expand Up @@ -72,7 +72,7 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": 7,
"id": "541857a7",
"metadata": {},
"outputs": [],
Expand Down
1 change: 1 addition & 0 deletions docs/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ ___________________________________
:caption: Table of Contents

SphinxTutorial
SphinxMulticatTutorial
SphinxContinuousTutorial
api
contributing
Expand Down
10 changes: 10 additions & 0 deletions docs/sphinx/tutorials.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Tutorials
#########

.. toctree::
:maxdepth: 1
:caption: Table of Contents

SphinxTutorial
SphinxMulticatTutorial
SphinxContinuousTutorial
1,158 changes: 1,158 additions & 0 deletions notebooks/Multi-Class Categorical Statistics.ipynb

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions notebooks/Tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"id": "a403ee30",
"metadata": {},
"source": [
"# Categorical Comparisons"
"# Two-Class Categorical Comparisons"
]
},
{
Expand Down Expand Up @@ -72,7 +72,7 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": 7,
"id": "541857a7",
"metadata": {},
"outputs": [],
Expand Down
Binary file added notebooks/benchmark_map_multi_categorical.tif
Binary file not shown.
Binary file added notebooks/candidate_map_multi_categorical.tif
Binary file not shown.
Binary file not shown.