Documentation

Main README in the root path proving the whole picture of the repo, svg banner, linking tutorials, contributing guidelines, resources and clone repository

GitHub resources

Open discussion forum to build our community (with templates for meetings, papers, ideas, general, licensees, etc)
Issue templates:
- to onboard new users to GitHub workflow and aws services
- request new features
- report bug issues
- For Pull Request review
CONTRIBUTING guidelines for good software practices on using git and github features (issues, branches, PRs, rebase, etc)
CODE_OF_CONDUCT to foster an open and welcoming environment.
Apache License 2.0

Adds a list of common pointers for software infrascture: pyproject, Pre-commit hooks, Unit tests with pytest, Documentation (docs, CONTRIBUTING, CODE_OF_CONDUCT), Datasets (datasets), Source folder (src)

Python library using pyproject for automatic multimodal medical image reporting.
Local development with python scripts using src path (not Jupiter notebooks which are not good practice for production pipelines)
Setup requirements to debug and develop models locally
Requirements for data
Devcontainers for local test
Unit test to version control models and datasets
Bash for easy debugging
precommit hooks to keep high-code quality
Licensing code using SPDX-FileCopyrightText and SPDX-License-Identifier. See src/amir/utils/datasets.py and src/amir/utils/utils.py.

Main README showing the whole picture to create/clean resources, setup arquitecture, cos of resources and benchmarking results.
Setup S3 Bucket
Bash scripts for easy interaction with aws-cli
Workflow to setup AWS Batch
- Prerequisites
- Architecture Overview
- Initial Setup: Login into AWS services, Create ECR Repository
- Container development: Build docker image, Verify image size, Local container testing, Stop container and remove it, Push to ECR
- AWS Infrastructure Setup: VPC Requirements, Create Compute Environment, Create Job Queue, Create Job Definition
- Job management
- Monitoring and troubleshooting
- Cleanup