Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update getting-started.md book: Python requirement for examples. #987

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update getting-started.md
Fixes #828
  • Loading branch information
antimora committed Nov 21, 2023
commit da8b46bc75ed5d9e06f7b31e550054cc5fc6c128
9 changes: 8 additions & 1 deletion burn-book/src/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Cargo, which was installed with Rust. In the directory of your choice, run
cargo new my_burn_app
```

This will create the `my_burn_app` project directory. Head inside with
This will create the `my_burn_app` project directory. Head inside with

```console
cd my_burn_app
Expand Down Expand Up @@ -78,3 +78,10 @@ Tensor {
While the previous example is somewhat trivial, the upcoming
[basic workflow section](./basic-workflow/README.md) will walk you through a much more relevant
example for deep learning applications.

## Running examples

Burn uses HuggingFace's [datasets](https://huggingface.co/docs/datasets/index) library to load
datasets. `datasets` is a Python library, and therefore, in order to run examples, you will need to
install Python. Follow the instructions on the [official website](https://www.python.org/downloads/)
to install Python on your computer.