Wiki_Structure

TODO

Proposed structure for wiki follows:

README.md

Format similar to that of pytorch:

• Project overview
  • Features
    • Our philosophy is pytorch's philosophy
    • Link to MONAI_Design_Philosophy.md for more detail
• Installation
  • package stuff still ongoing
• Getting started
  • Front-page exemplar
  • Link to MONAI_Developer_Guides.md
    • Adding MONAI elements to your projects
    • Making deeper use of MONAI
    • Building a MONAI-based project
  • Link to MONAI_Design.md
• Releases
  • Development process
    • Link to MONAI_Development_Process.md
  • Release cycles
  • Major / minor Releases
  • Patch releases
• Contributing
  • Link to MONAI_Contribution_Guidelines.md
• The team
  • Larger contribution and thank you page
• License

Wiki Home

• Link to MONAI_Wiki_Contribution_Guide.md
• Link to MONAI_Developer_Guides.md
• Link to MONAI_Design_Philosophy.md
• Link to MONAI_Design.md
• Link to MONAI_Design_Discussions.md
  • (Also linked from within the individual design pages)
• Other useful top level Links
  • MONAI_Contribution_Guidelines
  • MONAI_Continuous_Integration_And_Delivery_Pipeline.md

Wiki contribution guide (MONAI_Wiki_Contribution_Guide.md)

Structure Page naming Page formats

• TODO: think about headers / footers and useful navigational content that is included in every page

Design philosophy (MONAI_Design_Philosophy.md)

• Take design philosophy section out of design page but link to it
• Link to MONAI_Design.md
• Contents:
  • Introduction (was # Design philosophy)
  • An unopinionated framework (Was ## What does 'unopinionated'...)
    • Python, pytorch, ignite
    • Not prescriptive, but canonical examples
  • Vanilla functionality
  • Specialised functionality
  • Pythonic
  • Routes to using MONAI
    • Specific elements
    • Borrow parts of framework
    • Build MONAI-based applications
  • Engines and engine helpers

Design (MONAI_Design.md)

This page is a discussion of the concrete design decisions that have gone into MONAI, rather than a manual for using it.

• Design philosophy comes out of here and into its own page
• Link to MONAI_Tutorials.md
• Links to various design specialisation pages
  • Preprocessors and transforms - Link to MONAI_Preprocessor_Design.md
  • Datasets and DataLoaders
  • Network layers - Link to MONAI_Layer_Design.md
  • Networks - Link to MONAI_Network_Design.md
  • Loss functions
  • Metrics
  • Engines and Loops - Link to MONAI_Metric_Design.md
• Links to live design discussion specialisation Pages
  • Preprocessors and transforms - Link to MONAI_Preprocessor_Design_Discussion.md
  • Datasets and DataLoaders
  • Network layers - Link to MONAI_Layer_Design_Discussion.md (bring in layer factory also)
  • Networks - Link to MONAI_Network_Design_Discussion.md
  • Loss functions
  • Metrics
  • Engines and Loops - Link to MONAI_Metric_Design_Discussion.md

Developer Guides (MONAI_Developer_Guides.md)

These pages give developers constructive, canonical examples to work off, that highlight the design & philosophy of MONAI. They are not proscriptive, MONAI is not a proscriptive framework, but instead represent canonical examples of ways in which MONAI can be effectively used. Feel free to find alternative ways of using MONAI if that is your preference.

How to use / extend MONAI in your projects

• Specific elements
• Borrowing parts of the framework
• Building MONAI-based applications

Extending Monai

• Transforms - Link to renamed Developer-Guide-Transforms.md
  • Using transforms from multiple libraries
  • Writing your own Transforms
    • rename and extent Developer-Guide-Transforms.md
• Links to specialised developer guide pages
  • Datasets and DataLoaders
  • Network layers
  • Networks
  • Loss functions
  • Metrics
  • Engines and Loops
• Links to notebooks with end-to-end examples