nogibjj / candle-cookbook

Cookbook to build Rust Candle models

Candle Cookbook

Cooking live @ https://nogibjj.github.io/candle-cookbook/

🚀 Our Mission:

Democratize access to state of the art AI models.

⭐ Our Principles:

🫱🏾‍🫲🏼 Trust ~ ethically sourced data and end-to-end transparency.

🔒 Privacy ~ secure, on-device inference without data sharing.

🌏 Sustainability ~ optimize efficiency to minimize our carbon footprint.

---

🛣️ Roadmap

Our goal is to document each stage of a fully transparent LLM development cycle

• Publish MVP Candle Cookbook
• Ethically source and construct an openly available LLM dataset
• Build a Candle-based LLM from scratch
• Customize LLM with finetuning
• CI/CD deployment of LLM

---

🕯️Start Here

Welcome! Get familiar with Candle Cookbook by going through some of our favourite introductory tutorials

• Hello, Candle!
• Hello, Candle on AWS!
• Hello, Candle on Azure!

We also recommend getting familiar with the Official Candle framework and User Guide

• Huggingface Candle repo
• Candle User Guide

---

🌱 Contributing

We welcome contributions from anyone who aligns with Our Mission and Our Principles.

To get started as a contributor:

• Read our Code of Conduct
• Read the Contributor Guidelines
• Install Candle Cookbook according to the Developer Setup guide

---

🧑‍🍳 Our Team:

Get to know our Community Leaders

candle-cookbook's Issues

Refine Roadmap and Contributor Onboarding Experience

Goal

The aim of this issue is to refine the contributor onboarding process to ensure it's intuitive and welcoming for newcomers at various levels of experience.

Lets identify and smooth out any confusing aspects of the current userflow and establish a clear, step-by-step map that can facilitate a better understanding and engagement with our project.

Objectives

1. Clear Onboarding Pathways:

   • Create intuitive, goal-oriented onboarding flows that offer precise guidance for new contributors.
   • Enable contributors to easily navigate our system and articulate project details when sharing with others.

2. Continuous Feedback Integration:

   • Implement a Kaizen-inspired system that regularly solicits and integrates contributor feedback to refine the userflow.

Proposed Action Items

• Establish a UI/UX standard for the Candle Cookbook project.
• Consider developing a survey or feedback mechanism to gather contributors' experiences.
• Design an onboarding map to address identified issues and to clarify the path forward.
• Integrate the new onboarding guide within the Contributor Guidelines.

Additional Notes

I've attached a Miro board(WIP) screenshot that outlines the initial thoughts on the userflow and areas that may require attention. This visual aid can serve as a starting point for discussion and brainstorming on how to enhance our onboarding experience.

View the Miro Board here