Skip to content

Commit 4a36d14

Browse files
authored
Updating the README.md
Corrected the 'Back to the Top'
1 parent 6c4cb12 commit 4a36d14

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<div id="top"></div> </div>
2+
13
# `Kedro` Machine Learning Pipeline 🏯
24

35
<p align="center">
@@ -25,7 +27,7 @@ The objectives were:
2527
- **CI/CD Automation**: Implement an **automated CI/CD pipeline** using `GitHub Actions` to ensure continuous testing and code quality management.
2628
- **Dockerization**: Develop a **Dockerized pipeline** for ease of use, incorporating `Docker volumes` for persistent data management.
2729

28-
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
30+
<p align="right">(<a href="#top">back to top</a>)</p>
2931

3032
## 🛠️ Preparation & Prototyping in Notebooks
3133

@@ -53,7 +55,7 @@ The `Kedro Viz tool` provides an interactive canvas to visualize and **understan
5355

5456
With this tool, the understanding of data progression, outputs, and interactivity is greatly simplified. Kedro Viz allows users to inspect samples of data, view parameters, analyze figures, and much more, enriching the user experience with enhanced transparency and interactivity.
5557

56-
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
58+
<p align="right">(<a href="#top">back to top</a>)</p>
5759

5860
## 📜 Logging and Monitoring
5961

@@ -65,7 +67,7 @@ Logging is integral to understanding and troubleshooting pipelines. This project
6567

6668
Notice how the nodes are executed sequentially, and observe the **RMSE outputs during validation** for the **XGBoost model**. Logging in Kedro is highly customizable, allowing for tailored monitoring that meets the user's specific needs.
6769

68-
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
70+
<p align="right">(<a href="#top">back to top</a>)</p>
6971

7072
## 📁 Project Structure
7173

@@ -110,7 +112,7 @@ Kedro-Energy-Forecasting/
110112
└── requirements.txt # Project dependencies
111113
```
112114

113-
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
115+
<p align="right">(<a href="#top">back to top</a>)</p>
114116

115117
## 🚀 Getting Started
116118

@@ -135,7 +137,7 @@ Here is an example of the available targets: (you type `make` in the command lin
135137
- For **production** environments, initialize your setup by executing `make prep-doc` or using `pip install -r docker-requirements.txt` to install the production dependencies.
136138
- For a **development** environment, where you may want to use **Kedro Viz**, work with **Jupyter notebooks**, or test everything thoroughly, run `make prep-dev` or `pip install -r dev-requirements.txt` to install all the development dependencies.
137139

138-
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
140+
<p align="right">(<a href="#top">back to top</a>)</p>
139141

140142
### 🌿 Standard Method (Conda / venv)
141143

@@ -163,14 +165,14 @@ Prefer this method for a containerized approach, ensuring a consistent developme
163165

164166
For additional assistance or to explore more command options, refer to the **Makefile** or consult `kedro --help`.
165167

166-
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
168+
<p align="right">(<a href="#top">back to top</a>)</p>
167169

168170
## 🌌 Next Steps?
169171
With our **Kedro Pipeline** 🏗 now capable of efficiently **transforming raw** data 🔄 into **trained models** 🤖, and the introduction of a Dockerized environment 🐳 for our code, the next phase involves _advancing beyond the current repository scope_ 🚀 to `orchestrate data updates automatically` using tools like **Databricks**, **Airflow**, **Azure Data Factory**... This progression allows for the seamless integration of fresh data into our models.
170172

171173
Moreover, implementing `experiment tracking and versioning` with **MLflow** 📊 or leveraging **Kedro Viz**'s versioning capabilities 📈 will significantly enhance our project's management and reproducibility. These steps are pivotal for maintaining a clean machine learning workflow that not only achieves our goal of simplifying model training processes 🛠 but also ensures our system remains dynamic and scalable with **minimal effort**.
172174

173-
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
175+
<p align="right">(<a href="#top">back to top</a>)</p>
174176

175177
## 🌐 Let's Connect!
176178

0 commit comments

Comments
 (0)