Add example project showcasing full workflow using template

[pawansharma09]

This template offers excellent structure, but lacks a ready-to-use example that demonstrates a full research pipeline (data loading, feature generation, model training, tracking with W&B, packaging, inference).

I’d be happy to create a minimal example (e.g. Iris classification) that lives in an examples/ folder, with accompanying README and instructions. Would you be open to this addition?

[skandermoalla]

Thanks for the feedback! There is an example experiment under https://github.com/CLAIRE-Labo/python-ml-research-template/blob/main/src/template_package_name/template_experiment.py and an example project listed in the description https://github.com/CLAIRE-Labo/no-representation-no-trust.

Adding a simple ML pipeline can also be beneficial as an example project. I would not add it inside the template as it would be more code to maintain that is not necessary for the functioning of the template, but I would be very happy to list it under an examples section in the readme!

[pawansharma09]

Thank you for the quick and thoughtful response!

I completely agree that keeping the core template minimal and focused is essential. To that end, I’ve created a separate repository implementing an Iris classification pipeline that follows the structure and practices outlined in your template including modular components, config-driven execution, and model saving.

Here’s the link to the project: https://github.com/pawansharma09/iris-ml-template-example

If it aligns with your vision, I’d be honored to have it listed under the examples section in the README. I hope it proves useful for others exploring the template as a starting point.

Appreciate the opportunity to contribute as a fellow ML enthusiast!