Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

DOC: Add InnerEye/Azure docstrings to RTD #788

Merged
merged 29 commits into from
Sep 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
267d4e8
📝 Create basic for ML API
peterhessey Aug 5, 2022
806f261
📝 Add ML/configs base doc files
peterhessey Aug 5, 2022
0cbd7c7
📝 Finish ML/configs API
peterhessey Aug 8, 2022
f5c82cf
📝 Update augmentations
peterhessey Aug 8, 2022
ac0171a
📝 Add ML/dataset API docs
peterhessey Aug 8, 2022
e9fff6a
📝 Add rst skeleton for ML/models
peterhessey Aug 8, 2022
4fd8de4
📝 Fix docstring missing newlines
peterhessey Aug 8, 2022
6371548
Remove script
peterhessey Aug 8, 2022
27e7784
📝 Finish ML/models API docs
peterhessey Aug 8, 2022
6a1273f
📝 Start ML/SSL API. Fix some formatting issues
peterhessey Aug 9, 2022
562173b
📝 Correct whitespace issues in `:param`
peterhessey Aug 9, 2022
416e907
📝 Fix whitespace errors on `:return` statements
peterhessey Aug 9, 2022
a778dac
📝 Fix :return: statements
peterhessey Aug 9, 2022
33b557c
📝 Finish ML/SSL API
peterhessey Aug 9, 2022
7d4f466
📝 Add ML/utils API docs
peterhessey Aug 9, 2022
19ab5b2
📝 Add visualizer docs, fix `:raise` indents
peterhessey Aug 9, 2022
67169af
📝 Fix more issues with the `:raises:` formatting
peterhessey Aug 9, 2022
7619004
♻️ Restructuring folders
peterhessey Aug 9, 2022
bdc2a51
📝 Limit API `toctree` depth
peterhessey Aug 9, 2022
56c3a52
📝 Add primary InnerEye/ML files API to docs
peterhessey Aug 9, 2022
e9e5ee8
📝 Fix and add `InnerEye/ML/*.py` docs
peterhessey Aug 9, 2022
c1d84a8
⚰️ Remove weird `settings.json` change
peterhessey Aug 9, 2022
933bc7b
📌 Switch recommonmark to MyST-parser
peterhessey Aug 15, 2022
dcbf49e
📝 Add InnerEye/Azure docstrings to RTD
peterhessey Aug 15, 2022
ee959fe
💡 ♻️ Address review comments
peterhessey Aug 16, 2022
cde2d97
Fix conflicts merging main
peterhessey Aug 19, 2022
b5f92ce
📝 Update Azure title
peterhessey Aug 19, 2022
54afbc1
📝 ♻️ Address review comments
peterhessey Sep 12, 2022
be8dab6
Merge branch 'main' into phessey/add-azure-docstrings-to-RTD
peterhessey Sep 12, 2022
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
26 changes: 26 additions & 0 deletions docs/source/rst/api/Azure/azure.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Azure
=====

Below you will find the documentation for `InnerEye/Azure <https://github.com/microsoft/InnerEye-DeepLearning/tree/main/InnerEye/Azure>`_.


Runner
------

.. automodule:: InnerEye.Azure.azure_runner


Configuration
-------------

.. automodule:: InnerEye.Azure.azure_config


Utils
-----

.. automodule:: InnerEye.Azure.azure_util

.. automodule:: InnerEye.Azure.parser_util

.. automodule:: InnerEye.Azure.secrets_handling
Empty file.
4 changes: 3 additions & 1 deletion docs/source/rst/api/ML/ML.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Machine learning
================

Below you will find the docstrings of all resources found in `InnerEye/ML <https://github.com/microsoft/InnerEye-DeepLearning/tree/main/InnerEye/ML>`_.


.. toctree::
:caption: Docuemntation for InnerEye/ML

core
models
Expand Down
1 change: 1 addition & 0 deletions docs/source/rst/api/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. toctree::

ML/ML
Azure/azure
Scripts/scripts