Nathan Raw 9f5bba9ef9
Structure Hugging Face Docs (#1575)
* 🎨 structure docs

* 🚧 wip docs

* 📝 add installation doc

* 📝 wip docs

* 📝 wip docs

* 📝 wip docs

* 📝 wip docs

* 📝 wip docs

* 📝 add basic reference docs

* 📝 remove augmentation from toctree

* 👷 update pr doc builder to bugfix branch

* 📝 wip docs

* 🚧 wip

* 👷 bump CI

* 🚧 wip

* 🚧 bump CI

* 🚧 wip

* 🚧 wip

* 🚧 wip

* 📝 add hf hub tutorial doc

* 🔥 remove inference tut

* 🚧 wip

* 📝 wip docs

* 📝 wip docs

* 📝 update docs

* 📝 move validation script doc up in order

* 🎨 restructure to remove legacy docs

* 📝 update index doc

* 📝 update number of pretrained models

* Update hfdocs/README.md

* Update .github/workflows/build_pr_documentation.yml

* Update build_pr_documentation.yml

* bump

* 📌 update gh action to use main branch

* 🔥 remove comment
2023-01-03 14:13:53 -08:00

23 lines
1.5 KiB
Plaintext

# timm
<img class="float-left !m-0 !border-0 !dark:border-0 !shadow-none !max-w-lg w-[150px]" src="https://huggingface.co/front/thumbnails/docs/timm.png"/>
`timm` is a library containing SOTA computer vision models, layers, utilities, optimizers, schedulers, data-loaders, augmentations, and training/evaluation scripts.
It comes packaged with >700 pretrained models, and is designed to be flexible and easy to use.
Read the [quick start guide](quickstart) to get up and running with the `timm` library. You will learn how to load, discover, and use pretrained models included in the library.
<div class="mt-10">
<div class="w-full flex flex-col space-y-4 md:space-y-0 md:grid md:grid-cols-2 md:gap-y-4 md:gap-x-5">
<a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./feature_extraction"
><div class="w-full text-center bg-gradient-to-br from-blue-400 to-blue-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">Tutorials</div>
<p class="text-gray-700">Learn the basics and become familiar with timm. Start here if you are using timm for the first time!</p>
</a>
<a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./reference/models"
><div class="w-full text-center bg-gradient-to-br from-purple-400 to-purple-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">Reference</div>
<p class="text-gray-700">Technical descriptions of how timm classes and methods work.</p>
</a>
</div>
</div>