Skip to content

Commit 6c4cb12

Browse files
authored
Update README.md
Testing the Back to Top
1 parent a2fa5f3 commit 6c4cb12

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ The objectives were:
2525
- **CI/CD Automation**: Implement an **automated CI/CD pipeline** using `GitHub Actions` to ensure continuous testing and code quality management.
2626
- **Dockerization**: Develop a **Dockerized pipeline** for ease of use, incorporating `Docker volumes` for persistent data management.
2727

28+
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
29+
2830
## 🛠️ Preparation & Prototyping in Notebooks
2931

3032
Before I started making `Kedro pipelines`, I tried out my ideas in Jupyter notebooks. Check the `notebooks` folder to see how I did it:
@@ -51,6 +53,8 @@ The `Kedro Viz tool` provides an interactive canvas to visualize and **understan
5153

5254
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.
5355

56+
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
57+
5458
## 📜 Logging and Monitoring
5559

5660
Logging is integral to understanding and troubleshooting pipelines. This project leverages Kedro's logging capabilities to provide real-time insights into pipeline execution, highlighting progress, warnings, and errors. This GIF demonstrates the use of the `kedro run` or `make run` command, showcasing the logging output in action:
@@ -61,6 +65,8 @@ Logging is integral to understanding and troubleshooting pipelines. This project
6165

6266
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.
6367

68+
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
69+
6470
## 📁 Project Structure
6571

6672
A _simplified_ overview of the Kedro project's structure:
@@ -104,6 +110,8 @@ Kedro-Energy-Forecasting/
104110
└── requirements.txt # Project dependencies
105111
```
106112

113+
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
114+
107115
## 🚀 Getting Started
108116

109117
First, **Clone the Repository** to download a copy of the code onto your local machine, and before diving into transforming **raw data** into a **trained pickle Machine Learning model**, please note:
@@ -127,6 +135,7 @@ Here is an example of the available targets: (you type `make` in the command lin
127135
- For **production** environments, initialize your setup by executing `make prep-doc` or using `pip install -r docker-requirements.txt` to install the production dependencies.
128136
- 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.
129137

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

131140
### 🌿 Standard Method (Conda / venv)
132141

@@ -154,11 +163,15 @@ Prefer this method for a containerized approach, ensuring a consistent developme
154163

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

166+
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
167+
157168
## 🌌 Next Steps?
158169
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.
159170

160171
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**.
161172

173+
<div id="top"></div> </div><p align="right">(<a href="#top">back to top</a>)</p>
174+
162175
## 🌐 Let's Connect!
163176

164177
You can connect with me on **LinkedIn** or check out my **GitHub repositories**:

0 commit comments

Comments
 (0)