Skip to content
Snippets Groups Projects
Verified Commit 94ed4c01 authored by Björn Ludwig's avatar Björn Ludwig
Browse files

docs(examples): improve and correct examples section

parent 6fa8fc29
No related branches found
No related tags found
No related merge requests found
Examples Examples
======== ========
Proof-of-Concept examples
-------------------------
For certain proof of concepts, we provide Jupyter notebooks, which require For certain proof of concepts, we provide Jupyter notebooks, which require
additional dependencies to be installed. This can be achieved by appending additional dependencies to be installed. This is described in our
:code:`[examples]` to the install command, e.g. `INSTALL guide <https://zema-emc-annotated.readthedocs.io/en/latest/INSTALL.html#optional-jupyter-notebook-dependencies>`_
After executing the necessary command, you can browser through the following list but
.. code-block:: shell more importantly, check out the core class
`ZeMASamples <https://zema-emc-annotated.readthedocs.io/en/latest/zema_emc_annotated.dataset.html#zema_emc_annotated.dataset.ZeMASamples to get the samples in>`_.
pip install .[examples]
Afterwards you can browser through the following list:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Jupyter Notebook with code to access the dataset:
examples/read_dataset examples/read_dataset
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment