dnrops
/
burn
mirror of https://github.com/tracel-ai/burn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: link architecture doc (#310)

This commit is contained in:
Nathaniel Simard 2023-04-25 12:46:29 -04:00 committed by GitHub
parent 2865000080
commit 4773b7fb42
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
ARCHITECTURE.md
View File

@ -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. As of now, there is only one backend decorator that supports autodiff.
It follows the decorator pattern, making any backend differentiable. 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. 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
View File

@ -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. 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"> <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._ > *__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) * [Config](#config)
* [Learner](#learner) * [Learner](#learner)
* [no_std support](#no_std-support) * [no_std support](#no_std-support)
* [Contributing](#contributing)
* [Sponsors](#sponsors) * [Sponsors](#sponsors)
* [License](#license) * [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). 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. 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 ### 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. 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. 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 ## Sponsors
You can sponsor the founder of Burn from his [GitHub Sponsors profile](https://github.com/sponsors/nathanielsimard). You can sponsor the founder of Burn from his [GitHub Sponsors profile](https://github.com/sponsors/nathanielsimard).