-
Notifications
You must be signed in to change notification settings - Fork 363
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
Comments
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) |
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:
Then it should be at http://localhost:3000/ We will put it somewhere online some time soon |
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. |
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:
I am sure there are more but I really would love to dive in and read this book.
The text was updated successfully, but these errors were encountered: