mirror of
https://github.com/huggingface/candle.git
synced 2025-06-16 10:38:54 +00:00
76e565c4ab
* added CONTRIBUTING.md to candle-book * added description to candle-book introduction * Updated formatting and added different features to candle-book installation * mnist guide first draft candle-book * updated mnist guide syntax and grammar for candle-book * changed HelloWorld - Mnist to Tutorial - Mnist in SUMMARY.md * updated intro to mnist guide in candle-book
13 lines
474 B
Markdown
13 lines
474 B
Markdown
# Candle Book
|
|
|
|
The book uses [mdBook](https://github.com/rust-lang/mdBook) for building.
|
|
|
|
## Installation
|
|
|
|
To install mdBook, run `cargo install mdbook`. More instructions can be found [here](https://rust-lang.github.io/mdBook/guide/installation.html).
|
|
|
|
## Viewing the book
|
|
|
|
To view the book, run `mdbook serve --open candle-book`. More instructions can be found [here](https://rust-lang.github.io/mdBook/guide/creating.html).
|
|
|
|
The book is built automatically in github CI. |