Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adr more fixes #154

Merged
merged 6 commits into from
Nov 1, 2024
Merged

Adr more fixes #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9a0e2f5
a lot of formatting fixes
marinamatic Nov 1, 2024
8475f9c
template/spelling fixes
marinamatic Nov 1, 2024
13b5b5c
spelling, numbers, titles
marinamatic Nov 1, 2024
16dcd56
title fix
marinamatic Nov 1, 2024
38fa93c
more spelling and links added
marinamatic Nov 1, 2024
365c147
typo
marinamatic Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion documentation/ADRs/001_local_data_storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.*

---
2 changes: 1 addition & 1 deletion documentation/ADRs/002_seperation_of_configs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

|ADR Info| Details|
|--------------|-----------|
| Subject | Config file structure|
| Subject | Config File Structure|
| ADR Number | 002 |
| Status | Accepted |
| Author | Simon |
Expand Down
2 changes: 1 addition & 1 deletion documentation/ADRs/004_prediction_naming_convention.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

| ADR Info | Details |
|---------------------|------------------------------|
| Subject | Prediction naming convention |
| Subject | Prediction Naming Convention |
| ADR Number | 004 |
| Status | Accepted |
| Author | Xiaolong |
Expand Down
2 changes: 1 addition & 1 deletion documentation/ADRs/005_model_definition_and_structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
42 changes: 41 additions & 1 deletion documentation/ADRs/006_model_specific_inputdata_querysets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.*

---
42 changes: 41 additions & 1 deletion documentation/ADRs/007_distributed_dir_readme_files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.*

---
16 changes: 8 additions & 8 deletions documentation/ADRs/009_log_file_for_generated_data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion documentation/ADRs/010_evaluation_metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

| ADR Info | Details |
|---------------------|--------------------|
| Subject | Evaluation metrics |
| Subject | Evaluation Metrics |
| ADR Number | 010 |
| Status | Proposed |
| Author | Xiaolong |
Expand Down
2 changes: 1 addition & 1 deletion documentation/ADRs/011_Common_Querysets_for_Model_Pipelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Common Querysets for Model Pipelines
# Common Querysets for Model Pipelines


| ADR Info | Details |
Expand Down
2 changes: 1 addition & 1 deletion documentation/ADRs/012_artifact_naming_convention.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

| ADR Info | Details |
|---------------------|----------------------------|
| Subject | Artifact naming convention |
| Subject | Artifact Naming Convention |
| ADR Number | 012 |
| Status | Accepted |
| Author | Xiaolong |
Expand Down
2 changes: 1 addition & 1 deletion documentation/ADRs/013_output_naming_convention.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

| ADR Info | Details |
|---------------------|--------------------------|
| Subject | Output naming convention |
| Subject | Output Naming Convention |
| ADR Number | 013 |
| Status | Accepted |
| Author | Xiaolong |
Expand Down
4 changes: 2 additions & 2 deletions documentation/ADRs/014_input_drift_detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions documentation/ADRs/015_log_files_general_strategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion documentation/ADRs/016_input_drift_detection_logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Input Drift Detection Logging
# Input Drift Detection Logging


| ADR Info | Details |
Expand Down
57 changes: 50 additions & 7 deletions documentation/ADRs/017_log_files_for_offline_evaluation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Loading
Loading