tinygrad/docs
Alex Telon b66361843a
Timing and Context can now be used as decorators (#1385)
* Context and Timing can now be used as decorators

* Using Timing decorator in quickstart.md

The time formating is better and is a useful tool to learn.

Old: Time: 3.5260659999912605
New: Time: 3526.14 ms

* Updated env_vars documentation for Context

* Added test for Context decorator

* Put new import on same line as others
2023-08-01 17:16:10 -07:00
..
showcase Add yolov8 implementation (#806) 2023-06-16 18:55:19 -07:00
README.md Add a quick start guide (#900) 2023-06-04 08:51:20 -07:00
abstractions.py Revert "Fix constant folding for Tensor([3]) (#1227)" (#1274) 2023-07-19 10:51:06 -07:00
adding_new_accelerators.md Add WHERE ternary (or trinary?) op (#1196) 2023-07-16 00:31:55 -07:00
env_vars.md Timing and Context can now be used as decorators (#1385) 2023-08-01 17:16:10 -07:00
logo.png
quickstart.md Timing and Context can now be used as decorators (#1385) 2023-08-01 17:16:10 -07:00
showcase.md Add yolov8 implementation (#806) 2023-06-16 18:55:19 -07:00

README.md

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.

Or if you want to jump right in to how tinygrad works, you can read the abstraction stack documentation.

Or if you want to see some examples, you can look at the examples in the examples directory.

Or if you just want to see some of the things tinygrad can do, check out the showcase.

API

This is currently a big work in progress.

Resources

Environment Variables

env_vars.md

Adding New Accelerators

adding_new_accelerators.md

Community

tinygrad discord

Contributing

The documentation mainly follows the core contributing guidelines in the README.md.

Additionally, we always welcome documentation contributions, especially for features that are currently under documented.