AQ-AI / openaq-engine

http://www.aqai.xyz
BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

72 documentation in a githubio for example explaining how the data extraction and processing workflows #73

Closed ChristinaLast closed 1 month ago

ChristinaLast commented 1 month ago

Description

Addresses the following:

Documentation (in a GitHub.io, for example) explaining how the data extraction and processing workflows, through the creation and processing of features, algorithms applied and resulting models developed. Data lineage and process flow diagrams would be helpful to show here. |   | Architecture described initially in 72 -- | -- | -- Added bonus to show the evaluation metrics associated with MLFlow experiments with rankings of best performing models. |   | Added schema description in 72 The repository README (and generated documentation) is misleading. You don't need AWS EC2 for developing the model |   | Deleted AWS documentation in 72 -- | -- | -- There are references to MLFlow but the documentation of how it was provisioned and/or modified can't be found anywhere |   | Added in 72 Fixes #72 ## Type of change Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [X] This change requires a documentation update # How has this been tested? Please describe the tests that you ran to verify your changes. # Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes