Merge pull request #154 from prio-data/adr_more_fixes

Adr more fixes
prio-data · Nov 1, 2024 · c2f0c26 · c2f0c26
2 parents f888262 + 365c147
commit c2f0c26
Show file tree

Hide file tree

Showing 21 changed files with 369 additions and 55 deletions.
diff --git a/documentation/ADRs/001_local_data_storage.md b/documentation/ADRs/001_local_data_storage.md
@@ -1 +1,41 @@
-TODO
+# Local Data Storage
+
+| ADR Info            | Details           |
+|---------------------|-------------------|
+| Subject             | Local Data Storage  |
+| ADR Number          | 001   |
+| Status              | Proposed   |
+| Author              | Simon   |
+| Date                | [Insert Date (DD.MM.YYYY)]     |
+
+## Context
+*Describe the issue that necessitated the decision, including any factors considered during the decision-making process. This should provide a clear understanding of the challenges or opportunities addressed by the ADR.*
+
+## Decision
+*Detail the decision that was made, including any alternatives that were considered and the reasons for choosing the implemented solution. Provide enough technical specifics to justify the approach.*
+
+### Overview
+*Overview of the decision in a clear and concise manner.*
+
+## Consequences
+*Discuss the positive and negative effects of the decision. Include both immediate outcomes and long-term implications for the project's architecture. Highlight how the decision aligns with the challenges outlined in the context.*
+
+**Positive Effects:**
+- List the benefits of the decision.
+
+**Negative Effects:**
+- List the potential drawbacks or challenges introduced by the decision.
+
+## Rationale
+*Explain the reasoning behind the decision, including any specific advantages that influenced the choice. This section should reflect the factors mentioned in the context.*
+
+### Considerations
+*List any considerations that were part of the decision-making process, such as potential risks, dependency issues, or impacts on existing systems.*
+
+## Additional Notes
+*Include any additional information that might be relevant to the decision, such as implications for development workflows, future maintenance, or related decisions.*
+
+## Feedback and Suggestions
+*Invite team members or stakeholders to provide feedback or suggest improvements on the decision or its implementation.*
+
+---
diff --git a/documentation/ADRs/002_seperation_of_configs.md b/documentation/ADRs/002_seperation_of_configs.md
@@ -2,7 +2,7 @@
 
 |ADR Info| Details|
 |--------------|-----------|
-| Subject      | Config file structure|
+| Subject      | Config File Structure|
 | ADR Number   | 002       |
 | Status       | Accepted  |
 | Author       | Simon     |

diff --git a/documentation/ADRs/004_prediction_naming_convention.md b/documentation/ADRs/004_prediction_naming_convention.md
@@ -3,7 +3,7 @@
 
 | ADR Info            | Details                      |
 |---------------------|------------------------------|
-| Subject             | Prediction naming convention |
+| Subject             | Prediction Naming Convention |
 | ADR Number          | 004                          |
 | Status              | Accepted                     |
 | Author              | Xiaolong                     |

diff --git a/documentation/ADRs/005_model_definition_and_structure.md b/documentation/ADRs/005_model_definition_and_structure.md
@@ -4,7 +4,7 @@
 | ADR Info            | Details                                      |
 |---------------------|----------------------------------------------|
 | Subject             | Documentation of Models in VIEWS Pipeline    |
-| ADR Number          | 002                                          |
+| ADR Number          | 005                                          |
 | Status              | Accepted                                     |
 | Author              | Sara and Simon                               |
 | Date                | 29.07.2024                                   |

diff --git a/documentation/ADRs/006_model_specific_inputdata_querysets.md b/documentation/ADRs/006_model_specific_inputdata_querysets.md
@@ -1 +1,41 @@
-TODE
+# Model-Specific Input Data Querysets
+
+| ADR Info            | Details           |
+|---------------------|-------------------|
+| Subject             | Model-Specific Input Data Querysets  |
+| ADR Number          | 006   |
+| Status              | Proposed   |
+| Author              | Simon  |
+| Date                | [Insert Date (DD.MM.YYYY)]     |
+
+## Context
+*Describe the issue that necessitated the decision, including any factors considered during the decision-making process. This should provide a clear understanding of the challenges or opportunities addressed by the ADR.*
+
+## Decision
+*Detail the decision that was made, including any alternatives that were considered and the reasons for choosing the implemented solution. Provide enough technical specifics to justify the approach.*
+
+### Overview
+*Overview of the decision in a clear and concise manner.*
+
+## Consequences
+*Discuss the positive and negative effects of the decision. Include both immediate outcomes and long-term implications for the project's architecture. Highlight how the decision aligns with the challenges outlined in the context.*
+
+**Positive Effects:**
+- List the benefits of the decision.
+
+**Negative Effects:**
+- List the potential drawbacks or challenges introduced by the decision.
+
+## Rationale
+*Explain the reasoning behind the decision, including any specific advantages that influenced the choice. This section should reflect the factors mentioned in the context.*
+
+### Considerations
+*List any considerations that were part of the decision-making process, such as potential risks, dependency issues, or impacts on existing systems.*
+
+## Additional Notes
+*Include any additional information that might be relevant to the decision, such as implications for development workflows, future maintenance, or related decisions.*
+
+## Feedback and Suggestions
+*Invite team members or stakeholders to provide feedback or suggest improvements on the decision or its implementation.*
+
+---
diff --git a/documentation/ADRs/007_distributed_dir_readme_files.md b/documentation/ADRs/007_distributed_dir_readme_files.md
@@ -1 +1,41 @@
-TODO
+# Distributed Directory README Files
+
+| ADR Info            | Details           |
+|---------------------|-------------------|
+| Subject             |  Distributed Directories for README Files |
+| ADR Number          | 007   |
+| Status              | Proposed   |
+| Author              | Simon  |
+| Date                | [Insert Date (DD.MM.YYYY)]     |
+
+## Context
+*Describe the issue that necessitated the decision, including any factors considered during the decision-making process. This should provide a clear understanding of the challenges or opportunities addressed by the ADR.*
+
+## Decision
+*Detail the decision that was made, including any alternatives that were considered and the reasons for choosing the implemented solution. Provide enough technical specifics to justify the approach.*
+
+### Overview
+*Overview of the decision in a clear and concise manner.*
+
+## Consequences
+*Discuss the positive and negative effects of the decision. Include both immediate outcomes and long-term implications for the project's architecture. Highlight how the decision aligns with the challenges outlined in the context.*
+
+**Positive Effects:**
+- List the benefits of the decision.
+
+**Negative Effects:**
+- List the potential drawbacks or challenges introduced by the decision.
+
+## Rationale
+*Explain the reasoning behind the decision, including any specific advantages that influenced the choice. This section should reflect the factors mentioned in the context.*
+
+### Considerations
+*List any considerations that were part of the decision-making process, such as potential risks, dependency issues, or impacts on existing systems.*
+
+## Additional Notes
+*Include any additional information that might be relevant to the decision, such as implications for development workflows, future maintenance, or related decisions.*
+
+## Feedback and Suggestions
+*Invite team members or stakeholders to provide feedback or suggest improvements on the decision or its implementation.*
+
+---
diff --git a/documentation/ADRs/009_log_file_for_generated_data.md b/documentation/ADRs/009_log_file_for_generated_data.md
@@ -3,7 +3,7 @@
 
 | ADR Info            | Details                     |
 |---------------------|-----------------------------|
-| Subject             | Log file for generated data |
+| Subject             | Log File for Generated Data |
 | ADR Number          | 009                         |
 | Status              | Accepted                    |
 | Author              | Xiaolong                    |
@@ -16,19 +16,19 @@ This is critical to ensure the reliability and reproducibility of model outputs
 
 For related ADRs on the generation of different log files and other general logging standards/routines, please see the ADRs below:  [NOTE: new relevant ADRs links should be added]
 
-[016_input_drift_detection_logging](/documentation/ADRs/016_input_drift_detection_logging.md)
+- [016_input_drift_detection_logging](/documentation/ADRs/016_input_drift_detection_logging.md)
 
-[017_log_files_for_offline_evaluation](/documentation/ADRs/017_log_files_for_offline_evaluation.md)
+- [017_log_files_for_offline_evaluation](/documentation/ADRs/017_log_files_for_offline_evaluation.md)
 
-[018_log_files_for_online_evaluation](/documentation/ADRs/018_log_files_for_online_evaluation.md)
+- [018_log_files_for_online_evaluation](/documentation/ADRs/018_log_files_for_online_evaluation.md)
 
-[019_log_files_for_model_training](/documentation/ADRs/019_log_files_for_model_training.md)
+- [019_log_files_for_model_training](/documentation/ADRs/019_log_files_for_model_training.md)
 
-[020_log_files_and_realtime_alerts](/documentation/ADRs/020_log_files_and_realtime_alerts.md)
+- [020_log_files_and_realtime_alerts](/documentation/ADRs/020_log_files_and_realtime_alerts.md)
 
-[025_log_level_standards](/documentation/ADRs/025_log_level_standards.md)
+- [025_log_level_standards](/documentation/ADRs/025_log_level_standards.md)
 
-[026_log_files_for_input_data](/documentation/ADRs/026_log_files_for_input_data.md)
+- [026_log_files_for_input_data](/documentation/ADRs/026_log_files_for_input_data.md)
 
 
 ## Decision

diff --git a/documentation/ADRs/010_evaluation_metrics.md b/documentation/ADRs/010_evaluation_metrics.md
@@ -3,7 +3,7 @@
 
 | ADR Info            | Details            |
 |---------------------|--------------------|
-| Subject             | Evaluation metrics |
+| Subject             | Evaluation Metrics |
 | ADR Number          | 010                |
 | Status              | Proposed           |
 | Author              | Xiaolong           |

diff --git a/documentation/ADRs/011_Common_Querysets_for_Model_Pipelines.md b/documentation/ADRs/011_Common_Querysets_for_Model_Pipelines.md
@@ -1,4 +1,4 @@
-#Common Querysets for Model Pipelines
+# Common Querysets for Model Pipelines
 
 
 | ADR Info            | Details                           |

diff --git a/documentation/ADRs/012_artifact_naming_convention.md b/documentation/ADRs/012_artifact_naming_convention.md
@@ -3,7 +3,7 @@
 
 | ADR Info            | Details                    |
 |---------------------|----------------------------|
-| Subject             | Artifact naming convention |
+| Subject             | Artifact Naming Convention |
 | ADR Number          | 012                        |
 | Status              | Accepted                   |
 | Author              | Xiaolong                   |

diff --git a/documentation/ADRs/013_output_naming_convention.md b/documentation/ADRs/013_output_naming_convention.md
@@ -3,7 +3,7 @@
 
 | ADR Info            | Details                  |
 |---------------------|--------------------------|
-| Subject             | Output naming convention |
+| Subject             | Output Naming Convention |
 | ADR Number          | 013                      |
 | Status              | Accepted                 |
 | Author              | Xiaolong                 |

diff --git a/documentation/ADRs/014_input_drift_detection.md b/documentation/ADRs/014_input_drift_detection.md
@@ -2,11 +2,11 @@
 
 | ADR Info          | Details               |
 |-------------------|-----------------------|
-| Subject           | Input drift detection |
+| Subject           | Input Drift-Detection |
 | ADR Number        | 014                   |
 | Status            | Accepted              |
 | Author            | Jim Dale              |
-| Date              | 02/10/2024            |
+| Date              | 02.10.2024            |
 
 ## Context
 The pipeline needs machinery for checking that the input data entering it has not been compromised by problems or errors in the monthly data ingestion. This machinery also needs the ability to test itself.

diff --git a/documentation/ADRs/015_log_files_general_strategy.md b/documentation/ADRs/015_log_files_general_strategy.md
@@ -1,8 +1,8 @@
-# log files general strategy
+# Log Files General Strategy 
 
 | ADR Info            | Details                      |
 |---------------------|------------------------------|
-| Subject             | log files general strategy   |
+| Subject             | Log Files General Strategy   |
 | ADR Number          | 015                          |
 | Status              | Accepted                     |
 | Author              | Simon                        |

diff --git a/documentation/ADRs/016_input_drift_detection_logging.md b/documentation/ADRs/016_input_drift_detection_logging.md
@@ -1,4 +1,4 @@
-## Input Drift Detection Logging
+# Input Drift Detection Logging
 
 
 | ADR Info            | Details                       |

diff --git a/documentation/ADRs/017_log_files_for_offline_evaluation.md b/documentation/ADRs/017_log_files_for_offline_evaluation.md
@@ -1,18 +1,61 @@
+# Log Files for Offline Evaluation
 
+| ADR Info            | Details           |
+|---------------------|-------------------|
+| Subject             | Log Files for Offline Evaluation  |
+| ADR Number          | 017   |
+| Status              | Proposed   |
+| Author              |   |
+| Date                | [Insert Date (DD.MM.YYYY)]     |
 
+## Context
+*Describe the issue that necessitated the decision, including any factors considered during the decision-making process. This should provide a clear understanding of the challenges or opportunities addressed by the ADR.*
 
 For related ADRs on the generation of different log files and other general logging standards/routines, please see the ADRs below:  [NOTE: new relevant ADRs links should be added]
 
-[009_log_file_for_generated_data](/documentation/ADRs/009_log_file_for_generated_data.md) 
+- [009_log_file_for_generated_data](/documentation/ADRs/009_log_file_for_generated_data.md) 
 
-[016_input_drift_detection_logging](/documentation/ADRs/016_input_drift_detection_logging.md) 
+- [016_input_drift_detection_logging](/documentation/ADRs/016_input_drift_detection_logging.md) 
 
-[018_log_files_for_online_evaluation](/documentation/ADRs/018_log_files_for_online_evaluation.md) 
+- [018_log_files_for_online_evaluation](/documentation/ADRs/018_log_files_for_online_evaluation.md) 
 
-[019_log_files_for_model_training](/documentation/ADRs/019_log_files_for_model_training.md) 
+- [019_log_files_for_model_training](/documentation/ADRs/019_log_files_for_model_training.md) 
+
+- [020_log_files_and_realtime_alerts](/documentation/ADRs/020_log_files_and_realtime_alerts.md) 
+
+- [025_log_level_standards](/documentation/ADRs/025_log_level_standards.md) 
+
+- [026_log_files_for_input_data](/documentation/ADRs/026_log_files_for_input_data.md) 
+
+
+## Decision
+*Detail the decision that was made, including any alternatives that were considered and the reasons for choosing the implemented solution. Provide enough technical specifics to justify the approach.*
+
+### Overview
+*Overview of the decision in a clear and concise manner.*
+
+## Consequences
+*Discuss the positive and negative effects of the decision. Include both immediate outcomes and long-term implications for the project's architecture. Highlight how the decision aligns with the challenges outlined in the context.*
+
+**Positive Effects:**
+- List the benefits of the decision.
+
+**Negative Effects:**
+- List the potential drawbacks or challenges introduced by the decision.
+
+## Rationale
+*Explain the reasoning behind the decision, including any specific advantages that influenced the choice. This section should reflect the factors mentioned in the context.*
+
+### Considerations
+*List any considerations that were part of the decision-making process, such as potential risks, dependency issues, or impacts on existing systems.*
+
+## Additional Notes
+*Include any additional information that might be relevant to the decision, such as implications for development workflows, future maintenance, or related decisions.*
+
+## Feedback and Suggestions
+*Invite team members or stakeholders to provide feedback or suggest improvements on the decision or its implementation.*
+
+---
 
-[020_log_files_and_realtime_alerts](/documentation/ADRs/020_log_files_and_realtime_alerts.md) 
 
-[025_log_level_standards](/documentation/ADRs/025_log_level_standards.md) 
 
-[026_log_files_for_input_data](/documentation/ADRs/026_log_files_for_input_data.md)