Skip to content

[MODEL] Create models microreadme write one ordered list #226

@rojberr

Description

@rojberr

User Story:

As a model developer or consumer,
I want each model directory to have a standardized micro-README file,
So that anyone can quickly understand the model's purpose, usage, and characteristics without searching through documentation.


Acceptance Criteria:

  1. Create MICROREADME.md template with required sections
  2. Populate micro-READMEs for existing models

Definition of Done:

  • All acceptance criteria met
  • Template approved by team

Description:

We need standardized micro-READMEs in every model directory following this exact ordered list structure:

# [Model Name] Micro-README

1. **Purpose**: 
   - Primary function
   - Target use cases
   - Problem solved

2. **Architecture**:
   - Model type (e.g., U-Net, ResNet-50)
   - Key components

3. **Input Specifications**:
   - Format (e.g., GeoTIFF, PNG)
   - Dimensions
   - Channels
   - Normalization requirements

4. **Output Specifications**:
   - Format (e.g., probability mask, class index)
   - Interpretation guide
   - Sample visualization

5. **Training Data**:
   - Dataset source
   - Sample count
   - Class distribution
   - Augmentations applied

6. **Performance**:
   - Key metrics (IoU, Accuracy, F1)
   - Inference speed
   - Hardware requirements

7. **Usage**:
   - Minimum code example
   - Required dependencies
   - Pretrained weights location

8. **Limitations & Notes**:
   - Known edge cases
   - Deployment considerations
   - Version compatibility

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions