mirror of
https://github.com/tinygrad/tinygrad.git
synced 2026-01-10 07:28:15 -05:00
e9c1ae3825
* feat: initial quick start guide * fix: fix link * feat: add note about jit * feat: add note about load/store ops * feat: add link to discord * feat: add note about saving and loading models * fix: correct code for saving and loading * feat: overhaul docs * fix: fix link * feat: wording * feat: add link to discord * feat: contributing guidelines * feat: make contributing section more doc focused * feat: add link to env_vars from readme * fix: wording * feat: move community to bottom * feat: showcase * feat: linebreak * feat: redesigned header * feat: tweaks * feat: tweaks * feat: badge for lines of code * feat: move installation instructions to repo readme * feat: readme overhaul number 2 * feat: move visualization to quick start guide * feat: readme 2 electric boogaloo * fix: grammar * fix: formatting * feat: no ugly line * feat: add line back * feat: new load method * feat: split adding accelerator docs out * feat: showcase whisper * feat: smaller tweaks * feat: bring back oneliner
38 lines
1.1 KiB
Markdown
38 lines
1.1 KiB
Markdown
# Welcome to the tinygrad documentation!
|
|
|
|
Here you will find documentation for tinygrad, as well as some examples and tutorials.
|
|
|
|
## Getting Started
|
|
|
|
Read the quick start guide [here](/docs/quickstart.md).
|
|
|
|
Or if you want to jump right in to how tinygrad works, you can read the [abstraction stack](/docs/abstractions.py) documentation.
|
|
|
|
Or if you want to see some examples, you can look at the examples in the [examples](/examples) directory.
|
|
|
|
Or if you just want to see some of the things tinygrad can do, check out the [showcase](/docs/showcase.md).
|
|
|
|
## API
|
|
|
|
This is currently a big work in progress.
|
|
|
|
## Resources
|
|
|
|
### Environment Variables
|
|
|
|
[env_vars.md](/docs/env_vars.md)
|
|
|
|
### Adding New Accelerators
|
|
|
|
[adding_new_accelerators.md](/docs/adding_new_accelerators.md)
|
|
|
|
### Community
|
|
|
|
[](https://discord.gg/ZjZadyC7PK)
|
|
|
|
## Contributing
|
|
|
|
The documentation mainly follows the core contributing guidelines in the [README.md](/README.md#contributing).
|
|
|
|
Additionally, we always welcome documentation contributions, especially for features that are currently under documented.
|