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

Burn deserves its own book #200

Closed
antimora opened this issue Mar 6, 2023 · 3 comments
Closed

Burn deserves its own book #200

antimora opened this issue Mar 6, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@antimora
Copy link
Collaborator

antimora commented Mar 6, 2023

I believe Burn is more than a library or framework and it deserves documentation in the style of book, like Rust (https://doc.rust-lang.org/book/) or Serde (https://serde.rs/).

I would like to see these topic to be included:

  1. Introduction and motivation (pretty much from the first blog post: https://burn-rs.github.io/blog/a-case-for-rust-in-deep-learning)
  2. Overall design and concepts.
  3. Design goals and tenets for the project (kinda a promise what burn will be or evolve, similar to Rust's zero cost abstraction)
  4. Explanation of components (training, datasets , etc).
  5. Examples (training, inference, etc).
  6. Contributing, like how would I add a new backend or new tensor operations.
  7. Future road maps.

I am sure there are more but I really would love to dive in and read this book.

@antimora antimora added the documentation Improvements or additions to documentation label Apr 2, 2023
@wdoppenberg
Copy link
Contributor

wdoppenberg commented Aug 10, 2023

I tried to make a small setup for a book; it's far from complete. Let me know what you think:

(SUMMARY.md)

[Overview](../../README.md)

[Motivation](./motivation.md)

[Installation](./installation.md)

- [Usage](./usage/README.md)
  - [Quick Start](./usage/quick-start.md)
- [Concepts](./concepts/README.md)
  - [Tensors](./concepts/tensors.md)
  - [Backend](./concepts/backend.md)
  - [Configs](./concepts/configs.md)
  - [Datasets](./concepts/datasets.md)
  - [Models](./concepts/models.md)
  - [Metrics](./concepts/metrics.md)
  - [Losses](./concepts/losses.md)
  - [Optimizers](./concepts/optimizers.md)
  - [Advanced](./concepts/advanced/README.md)
    - [Records](./concepts/advanced/records.md)
    - [Macros](./concepts/advanced/macros.md)
- [Examples](./examples/README.md)
  - [MNIST](./examples/mnist.md)
  - [MNIST Inference on Web](./examples/mnist-inference-on-web.md)
  - [Named Tensors](./examples/named-tensors.md)
  - [ONNX Inference](./examples/onnx-inference.md)
  - [Text Classification](./examples/text-classification.md)
  - [Text Generation](./examples/text-generation.md)

[Zero to LLaMA2](./zero-to-llama2.md)

[Help](./help.md)

[Contributing](./contributing.md)

@wdoppenberg wdoppenberg mentioned this issue Aug 10, 2023
1 task
@antimora
Copy link
Collaborator Author

Linking the follow up PR: #632

Update: we have the first draft with guide section. Please check out it. It's on main. To view run this:

  1. cargo install mdbook
  2. Then in burn-book: mdbook serve

Then it should be at http://localhost:3000/

We will put it somewhere online some time soon

@antimora
Copy link
Collaborator Author

antimora commented Sep 8, 2023

Thanks everyone (@wdoppenberg , @louisfd , @nathanielsimard ) for launching Burn's own book. Many would very appreciate this!

Here is the link again to the book: https://burn-rs.github.io/book/

We will probably have another book on Development Guide that will have Design, Tenets, etc, so that we can refer to when adding new features, and it'd be very useful for new contributors.

Closing as complete.

@antimora antimora closed this as completed Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants