Skip to content

Commit

Permalink
Update notebooks.rst
Browse files Browse the repository at this point in the history
fix typos
  • Loading branch information
tsaycal authored Dec 4, 2023
1 parent a3bf300 commit 151934e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/notebooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Jupyter Notebooks
OMLT provides Jupyter notebooks to demonstrate its core capabilities. All notebooks can be found on the OMLT
github `page <https://github.com/cog-imperial/OMLT/tree/main/docs/notebooks/>`_.

The first set of notebooks demonstrate the basic mechanics of OMLT and show how to use it:
The first set of notebooks demonstrates the basic mechanics of OMLT and shows how to use it:

* `build_network.ipynb <https://github.com/cog-imperial/OMLT/blob/main/docs/notebooks/neuralnet/build_network.ipynb/>`_ shows how to manually create a `NetworkDefinition` object. This notebook is helpful for understanding the details of the internal layer structure that OMLT uses to represent neural networks.

Expand All @@ -14,11 +14,11 @@ The first set of notebooks demonstrate the basic mechanics of OMLT and show how

* `index_handling.ipynb <https://github.com/cog-imperial/OMLT/blob/main/docs/notebooks/neuralnet/index_handling.ipynb>`_ shows how to use `IndexMapper` to handle the mappings between indexes.

* `bo_with_trees.ipynb <https://github.com/cog-imperial/OMLT/blob/main/docs/notebooks/bo_with_trees.ipynb>`_ incorporates gradient-boosted-trees into a Bayesian optimization loop to optimize the Rosenbrock function.
* `bo_with_trees.ipynb <https://github.com/cog-imperial/OMLT/blob/main/docs/notebooks/bo_with_trees.ipynb>`_ incorporates gradient-boosted trees into a Bayesian optimization loop to optimize the Rosenbrock function.

* `linear_tree_formulations.ipynb <https://github.com/cog-imperial/OMLT/blob/main/docs/notebooks/trees/linear_tree_formulations.ipynb>`_ showcases the different linear model decision tree formulations available in OMLT.

The second set of notebooks give application specific examples:
The second set of notebooks gives application-specific examples:

* `mnist_example_dense.ipynb <https://github.com/cog-imperial/OMLT/blob/main/docs/notebooks/neuralnet/mnist_example_dense.ipynb>`_ trains a fully dense neural network on MNIST and uses OMLT to find adversarial examples.

Expand All @@ -27,4 +27,4 @@ The second set of notebooks give application specific examples:
* `auto-thermal-reformer.ipynb <https://github.com/cog-imperial/OMLT/blob/main/docs/notebooks/neuralnet/auto-thermal-reformer.ipynb>`_ develops a neural network surrogate (using sigmoid activations) with data from a process model built using `IDAES-PSE <https://github.com/IDAES/idaes-pse>`_.

* `auto-thermal-reformer-relu.ipynb <https://github.com/cog-imperial/OMLT/blob/main/docs/notebooks/neuralnet/auto-thermal-reformer-relu.ipynb>`_ develops a neural network surrogate (using ReLU activations) with data from a process model built using `IDAES-PSE <https://github.com/IDAES/idaes-pse>`_.
*
*

0 comments on commit 151934e

Please sign in to comment.