InnerEye-DeepLearning/docs
Peter Hessey d902e02fc6
ENH: Adapt HelloWorld to run using the Inference Service (#837)
Closes #696.

Changes the HelloWorld model to only use a single channel, as this is
the format that the [Inference
Service](https://github.com/microsoft/InnerEye-Inference/) expects for
its inputs.

As many tests require the 2-channel data, this PR also creates a new
class, `HelloWorld2Channel`, which inherits from `HelloWorld` but uses 2
channels and can be used for testing. This avoids the pain of having to
alter all unit and regression tests that relied on the 2-channel data
and model.

Both models can be trained on the same data, but now the `HelloWorld`
model can be run by the Inference Service.
2022-11-22 11:00:04 +00:00
..
source ENH: Adapt HelloWorld to run using the Inference Service (#837) 2022-11-22 11:00:04 +00:00
Makefile ENH: Move docs to ReadTheDocs (#768) 2022-08-04 09:15:19 +01:00
README.md ENH: Switch recommonmark to MyST-parser (#787) 2022-08-18 13:39:49 +01:00
make.bat ENH: Move docs to ReadTheDocs (#768) 2022-08-04 09:15:19 +01:00

README.md

Building docs for InnerEye-DeepLearning

  1. First, make sure you have set up your conda environment as described in the Quick Setup Guide.
  2. Run make html from the docs folder. This will create html files under docs/build/html.
  3. From the docs/build/html folder, run python -m http.server 8080 to host the docs locally.
  4. From your browser, navigate to http://localhost:8080 to view the documentation.