diff --git a/docs/source/data/hazelnut_toy.rst b/docs/source/data/hazelnut_toy.rst new file mode 100644 index 0000000000..139147db96 --- /dev/null +++ b/docs/source/data/hazelnut_toy.rst @@ -0,0 +1,37 @@ +Hazelnut Toy +============ + +You can download the toy hazelnut dataset from :download:`here <./hazelnut_toy.zip>`. Distributed under CC-BY-4.0 license. + + +.. list-table:: + :class: borderless + + * - .. figure:: ../images/datasets/hazelnut_toy/good.jpg + :scale: 25 % + + Example Good Image + +.. list-table:: + :class: borderless + + * - .. figure:: ../images/datasets/hazelnut_toy/colour.jpg + :scale: 25 % + + Example Colour Defect + + - .. figure:: ../images/datasets/hazelnut_toy/colour_mask.jpg + :scale: 25 % + + Example Mask of Colour Defect + + + * - .. figure:: ../images/datasets/hazelnut_toy/crack.jpg + :scale: 25 % + + Example Crack Defect + + - .. figure:: ../images/datasets/hazelnut_toy/crack_mask.jpg + :scale: 25 % + + Example Mask of Crack Defect diff --git a/docs/source/data/hazelnut_toy.zip b/docs/source/data/hazelnut_toy.zip new file mode 100644 index 0000000000..f9d47d8268 Binary files /dev/null and b/docs/source/data/hazelnut_toy.zip differ diff --git a/docs/source/guides/developing_on_docker.rst b/docs/source/guides/developing_on_docker.rst index 5ed004054b..c2f01e28fb 100644 --- a/docs/source/guides/developing_on_docker.rst +++ b/docs/source/guides/developing_on_docker.rst @@ -3,7 +3,7 @@ Developing on Docker ====================== -.. note:: +.. note:: You need a CUDA-capable GPU with suitable drivers installed 1. Install `Docker `_ @@ -42,10 +42,10 @@ This creates an interactive bash session inside the Docker container, in which y The source code is mapped into the running container by means of the `-v "$(pwd)":/anomalib` parameter. This facilitates changes to the source code without having to rebuild the Docker image. -.. note:: +.. note:: To forward graphical output of the Docker container to the host operating system, you have to disable access control of the host's X11 server. To this end, execute the shell command `xhost +` on the host. - - + + Using VSCode ============ diff --git a/docs/source/images/datasets/hazelnut_toy/colour.jpg b/docs/source/images/datasets/hazelnut_toy/colour.jpg new file mode 100644 index 0000000000..ceb643434a Binary files /dev/null and b/docs/source/images/datasets/hazelnut_toy/colour.jpg differ diff --git a/docs/source/images/datasets/hazelnut_toy/colour_mask.jpg b/docs/source/images/datasets/hazelnut_toy/colour_mask.jpg new file mode 100644 index 0000000000..6e72bceaaa Binary files /dev/null and b/docs/source/images/datasets/hazelnut_toy/colour_mask.jpg differ diff --git a/docs/source/images/datasets/hazelnut_toy/crack.jpg b/docs/source/images/datasets/hazelnut_toy/crack.jpg new file mode 100644 index 0000000000..3ccaff85ae Binary files /dev/null and b/docs/source/images/datasets/hazelnut_toy/crack.jpg differ diff --git a/docs/source/images/datasets/hazelnut_toy/crack_mask.jpg b/docs/source/images/datasets/hazelnut_toy/crack_mask.jpg new file mode 100644 index 0000000000..c349f1db16 Binary files /dev/null and b/docs/source/images/datasets/hazelnut_toy/crack_mask.jpg differ diff --git a/docs/source/images/datasets/hazelnut_toy/good.jpg b/docs/source/images/datasets/hazelnut_toy/good.jpg new file mode 100644 index 0000000000..092ce68bea Binary files /dev/null and b/docs/source/images/datasets/hazelnut_toy/good.jpg differ diff --git a/docs/source/index.rst b/docs/source/index.rst index e61e29a998..641e5ff045 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,8 +1,3 @@ -.. Anomalib documentation master file, created by - sphinx-quickstart on Sat Jul 31 09:38:12 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Welcome to Anomalib's documentation! ==================================== @@ -51,6 +46,12 @@ This repository as been tested on guides/using_tox guides/using_pre_commit +.. toctree:: + :maxdepth: 1 + :caption: Datasets + + data/hazelnut_toy + .. toctree:: :maxdepth: 1 :caption: Research