Skip to content

Commit

Permalink
add start here
Browse files Browse the repository at this point in the history
  • Loading branch information
athletedecoded committed Nov 13, 2023
1 parent d3eb3c8 commit d6ab386
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 13 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,30 @@ Our goal is to document each stage of a fully transparent LLM development cycle

<hr>

## 🌱 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

<hr>
* [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)

<hr>

## 🌱 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

<hr>

Expand Down
25 changes: 18 additions & 7 deletions src/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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)

0 comments on commit d6ab386

Please sign in to comment.