From d6ab386f8b098788bfbb99ccf26a395808258319 Mon Sep 17 00:00:00 2001 From: Kahlia Hogg <47726907+athletedecoded@users.noreply.github.com> Date: Mon, 13 Nov 2023 19:39:30 +0000 Subject: [PATCH] add start here --- README.md | 23 +++++++++++++++++------ src/home.md | 25 ++++++++++++++++++------- 2 files changed, 35 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f241934..cae7805 100644 --- a/README.md +++ b/README.md @@ -30,19 +30,30 @@ Our goal is to document each stage of a fully transparent LLM development cycle
-## 🌱 Contributing - -We welcome contributions from anyone who aligns with Our Mission and Our Principles. +## 🕯️Start Here -Get started by reading our [Code of Conduct](./CODE_OF_CONDUCT.md) then check out the [Contributor Guidelines](./CONTRIBUTING.md). +Welcome! Get familiar with Candle Cookbook by going through some of our favourite introductory tutorials -
+* [Hello, Candle!](./src/local/hello-candle.md) +* [Hello, Candle on AWS!](./src/aws/hello-aws.md) +* [Hello, Candle on Azure!](./src/azure/hello-azure.md) -## 🕯️Official Candle Docs +We also recommend getting familiar with the Official Candle framework and User Guide * [Huggingface Candle repo](https://github.com/huggingface/candle) * [Candle User Guide](https://huggingface.github.io/candle/guide/installation.html) +
+ +## 🌱 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](./CODE_OF_CONDUCT.md) +* Read the [Contributor Guidelines](./CONTRIBUTING.md) +* Install Candle Cookbook according to the [Developer Setup](./docs/DEV_ENV.md) guide
diff --git a/src/home.md b/src/home.md index d20d667..83fc5c9 100644 --- a/src/home.md +++ b/src/home.md @@ -12,11 +12,28 @@ Democratize access to state of the art AI models. 🌱 **Sustainability** ~ optimize efficiency to minimize our carbon footprint. +## 🕯️ Start Here + +Welcome! Get familiar with Candle Cookbook by going through some of our favourite introductory tutorials + +* [Hello, Candle!](./local/hello-candle.md) +* [Hello, Candle on AWS!](./aws/hello-aws.md) +* [Hello, Candle on Azure!](./azure/hello-azure.md) + +We also recommend getting familiar with the Official Candle framework and User Guide + +* [Huggingface Candle repo](https://github.com/huggingface/candle) +* [Candle User Guide](https://huggingface.github.io/candle/guide/installation.html) + ## 🌱 Contributing We welcome contributions from anyone who aligns with Our Mission and Our Principles. -Get started by reading our [Code of Conduct](https://github.com/nogibjj/candle-cookbook/blob/main/CODE_OF_CONDUCT.md) then check out the [Contributor Guidelines](https://github.com/nogibjj/candle-cookbook/blob/main/CONTRIBUTING.md). +To get started as a contributor: + +* Read our [Code of Conduct](../CODE_OF_CONDUCT.md) +* Read the [Contributor Guidelines](../CONTRIBUTING.md) +* Install Candle Cookbook according to the [Developer Setup](../docs/DEV_ENV.md) guide ## 🍳 The Recipes: @@ -63,9 +80,3 @@ Our goal is to document each stage of a fully transparent LLM development cycle Get to know our [Community Leaders](https://github.com/nogibjj/candle-cookbook/blob/main/TEAM.md) - -## 🕯️Official Candle Docs - -* [Huggingface Candle repo](https://github.com/huggingface/candle) -* [Candle User Guide](https://huggingface.github.io/candle/guide/installation.html) -