mirror of https://github.com/tracel-ai/burn.git
doc: link architecture doc (#310)
This commit is contained in:
parent
2865000080
commit
4773b7fb42
|
@ -214,3 +214,4 @@ Note that Burn is a dynamic graph deep learning framework, so backends may have
|
|||
As of now, there is only one backend decorator that supports autodiff.
|
||||
It follows the decorator pattern, making any backend differentiable.
|
||||
However, the `ADBackend` trait abstracts how gradients are calculated, and other approaches to autodiff might be added later.
|
||||
For more information about how the current autodiff backend works, you can read this [blog post](https://burn-rs.github.io/blog/burn-rusty-approach-to-tensor-handling).
|
||||
|
|
12
README.md
12
README.md
|
@ -12,11 +12,6 @@
|
|||
|
||||
This library strives to serve as a comprehensive **deep learning framework**, offering exceptional flexibility and written in Rust. Our objective is to cater to both researchers and practitioners by simplifying the process of experimenting, training, and deploying models.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div align="left">
|
||||
|
||||
> *__Disclamer__* _Burn is currently in active development, and there will be breaking changes. While any resulting issues are likely to be easy to fix, there are no guarantees at this stage._
|
||||
|
@ -34,6 +29,7 @@ __Sections__
|
|||
* [Config](#config)
|
||||
* [Learner](#learner)
|
||||
* [no_std support](#no_std-support)
|
||||
* [Contributing](#contributing)
|
||||
* [Sponsors](#sponsors)
|
||||
* [License](#license)
|
||||
|
||||
|
@ -51,6 +47,7 @@ __Sections__
|
|||
|
||||
The best way to get started with `burn` is to clone the repo and play with the [examples](#examples).
|
||||
This may also be a good idea to take a look the main [components](#components) of `burn` to get a quick overview of the fundamental building blocks.
|
||||
If you're interested in how the framework works, you can read our [architecture document](https://github.com/burn-rs/burn/tree/main/ARCHITECTURE.md).
|
||||
|
||||
### Examples
|
||||
|
||||
|
@ -230,6 +227,11 @@ Additionally `burn-core` and `burn-tensor` crates support `no_std` with `alloc`
|
|||
Note, under the `no_std` mode, a random seed is generated during the build time if the seed is not initialized by `Backend::seed` method.
|
||||
Additionally, [spin::mutex::Mutex](https://docs.rs/spin/latest/spin/mutex/struct.Mutex.html) is used in place of [std::sync::Mutex](https://doc.rust-lang.org/std/sync/struct.Mutex.html) under the `no_std` mode.
|
||||
|
||||
## Contributing
|
||||
|
||||
Before contributing, please take a moment to review our [code of conduct](https://github.com/burn-rs/burn/tree/main/CODE-OF-CONDUCT.md).
|
||||
It's also highly recommended to read our [architecture document](https://github.com/burn-rs/burn/tree/main/ARCHITECTURE.md), which explains our architectural decisions.
|
||||
|
||||
## Sponsors
|
||||
|
||||
You can sponsor the founder of Burn from his [GitHub Sponsors profile](https://github.com/sponsors/nathanielsimard).
|
||||
|
|
Loading…
Reference in New Issue