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

Docs/add nb for download #66

Merged
merged 21 commits into from
Sep 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
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
524 changes: 524 additions & 0 deletions notebooks/Classification_simulation_example_Facet.ipynb

Large diffs are not rendered by default.

982 changes: 982 additions & 0 deletions notebooks/Classification_with_Facet.ipynb

Large diffs are not rendered by default.

1,070 changes: 1,070 additions & 0 deletions notebooks/Predictive_Maintenance_Regression_with_Facet.ipynb

Large diffs are not rendered by default.

1,301 changes: 1,301 additions & 0 deletions notebooks/Regression_Water_Drilling_Simulation_Example.ipynb

Large diffs are not rendered by default.

82 changes: 0 additions & 82 deletions sphinx/Makefile

This file was deleted.

2 changes: 2 additions & 0 deletions sphinx/auxiliary/Boston_getting_started_example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
"cell_type": "code",
"execution_count": 1,
"metadata": {
"delete_for_interactive": true,
"nbsphinx": "hidden"
},
"outputs": [
Expand Down Expand Up @@ -144,6 +145,7 @@
"cell_type": "code",
"execution_count": 8,
"metadata": {
"delete_for_interactive": true,
"nbsphinx": "hidden"
},
"outputs": [],
Expand Down
59 changes: 0 additions & 59 deletions sphinx/make.bat

This file was deleted.

7 changes: 6 additions & 1 deletion sphinx/make.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from typing import Callable, NamedTuple, Tuple
import shutil
import subprocess
from source.scripts.transform_notebook import docs_notebooks_to_interactive

pwd = os.path.realpath(os.path.dirname(__file__))

Expand All @@ -15,11 +16,13 @@
# todo: check which ones are eventually obsolete
FACET_SOURCEDIR = os.path.join(pwd, os.pardir, "src")
SOURCEDIR = os.path.join(pwd, "source")
AUXILIARYDIR = os.path.join(pwd, "auxiliary")
SOURCEAPIDIR = os.path.join(SOURCEDIR, "api")
BUILDDIR = os.path.join(pwd, "build")
TEMPLATEDIR = os.path.join(SOURCEDIR, "_templates")
SCRIPTSDIR = os.path.join(SOURCEDIR, "scripts")
TUTORIALDIR = os.path.join(SOURCEDIR, os.pardir, "notebooks")
TUTORIALDIR = os.path.join(SOURCEDIR, "tutorial")
NOTEBOOKDIR = os.path.join(FACET_SOURCEDIR, os.pardir, "notebooks")
TUTORIALBUILD = os.path.join(SCRIPTSDIR, "transform_notebook.py")


Expand Down Expand Up @@ -73,6 +76,8 @@ def fun_html():
subprocess.run(
args=f"{CMD_SPHINXBUILD} {' '.join(sphinx_html_opts)}", shell=True, check=True
)
docs_notebooks_to_interactive(TUTORIALDIR, NOTEBOOKDIR)
# docs_notebooks_to_interactive(AUXILIARYDIR, NOTEBOOKDIR)


# Define MakeCommands
Expand Down
4 changes: 4 additions & 0 deletions sphinx/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Classification using FACET

tutorial/Classification_with_Facet



Predictive Maintenance Regression
------------------------------------------------
.. toctree::
Expand All @@ -21,6 +23,7 @@ Predictive Maintenance Regression
tutorial/Predictive_Maintenance_Regression_with_Facet



Understanding synergy and redundancy through simulation
------------------------------------------------------------
.. toctree::
Expand All @@ -29,6 +32,7 @@ Understanding synergy and redundancy through simulation
tutorial/Classification_simulation_example_Facet



Regression machine failures on a water well (simulated)
-----------------------------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"cell_type": "code",
"execution_count": null,
"metadata": {
"delete_for_interactive": true,
"nbsphinx": "hidden"
},
"outputs": [],
Expand Down Expand Up @@ -130,6 +131,7 @@
"cell_type": "code",
"execution_count": null,
"metadata": {
"delete_for_interactive": true,
"nbsphinx": "hidden"
},
"outputs": [],
Expand Down
2 changes: 2 additions & 0 deletions sphinx/source/tutorial/Classification_with_Facet.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"cell_type": "code",
"execution_count": null,
"metadata": {
"delete_for_interactive": true,
"nbsphinx": "hidden"
},
"outputs": [],
Expand Down Expand Up @@ -145,6 +146,7 @@
"cell_type": "code",
"execution_count": null,
"metadata": {
"delete_for_interactive": true,
"nbsphinx": "hidden"
},
"outputs": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"end_time": "2020-08-28T14:29:36.416582Z",
"start_time": "2020-08-28T14:29:36.410164Z"
},
"delete_for_interactive": true,
"nbsphinx": "hidden"
},
"outputs": [],
Expand Down Expand Up @@ -109,6 +110,7 @@
"end_time": "2020-08-28T14:29:36.537625Z",
"start_time": "2020-08-28T14:29:36.419137Z"
},
"delete_for_interactive": true,
"nbsphinx": "hidden"
},
"outputs": [],
Expand Down