{"id":13614942,"url":"https://github.com/grok-ai/nn-template","last_synced_at":"2025-04-04T10:09:06.656Z","repository":{"id":37956671,"uuid":"342075042","full_name":"grok-ai/nn-template","owner":"grok-ai","description":"Generic template to bootstrap your PyTorch project.","archived":false,"fork":false,"pushed_at":"2023-10-12T19:33:10.000Z","size":2808,"stargazers_count":641,"open_issues_count":1,"forks_count":67,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-03-28T09:09:07.921Z","etag":null,"topics":["best-practices","best-practises","cookiecutter","deep-learning","dvc","github-actions","huggingface-datasets","hydra","mkdocs","pre-commit","project-structure","pytorch","pytorch-lightning","reproducibility","research","streamlit","template","wandb","weights-and-biases"],"latest_commit_sha":null,"homepage":"https://grok-ai.github.io/nn-template","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grok-ai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-02-25T00:30:56.000Z","updated_at":"2025-03-21T17:36:04.000Z","dependencies_parsed_at":"2024-01-07T06:00:02.744Z","dependency_job_id":"ad67c6f1-8627-454c-8aba-ec3302f651dd","html_url":"https://github.com/grok-ai/nn-template","commit_stats":null,"previous_names":["lucmos/nn-template"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grok-ai%2Fnn-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grok-ai%2Fnn-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grok-ai%2Fnn-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grok-ai%2Fnn-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grok-ai","download_url":"https://codeload.github.com/grok-ai/nn-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247157283,"owners_count":20893220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["best-practices","best-practises","cookiecutter","deep-learning","dvc","github-actions","huggingface-datasets","hydra","mkdocs","pre-commit","project-structure","pytorch","pytorch-lightning","reproducibility","research","streamlit","template","wandb","weights-and-biases"],"created_at":"2024-08-01T20:01:07.295Z","updated_at":"2025-04-04T10:09:06.633Z","avatar_url":"https://github.com/grok-ai.png","language":"Python","funding_links":[],"categories":["Resources","Python"],"sub_categories":[],"readme":"# NN Template\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/grok-ai/nn-template/actions/workflows/test_suite.yml\"\u003e\u003cimg alt=\"CI\" src=https://github.com/grok-ai/nn-template/actions/workflows/test_suite.yml/badge.svg?branch=main\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/grok-ai/nn-template/actions/workflows/test_suite.yml\"\u003e\u003cimg alt=\"CI\" src=https://github.com/grok-ai/nn-template/actions/workflows/test_suite.yml/badge.svg?branch=develop\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/grok-ai/nn-template/actions/workflows/publish_docs.yml/badge.svg\"\u003e\u003cimg alt=\"Docs\" src=https://github.com/grok-ai/nn-template/actions/workflows/publish_docs.yml/badge.svg\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/nn-template-core/\"\u003e\u003cimg alt=\"Release\" src=\"https://img.shields.io/pypi/v/nn-template-core?label=nn-core\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://black.readthedocs.io/en/stable/\"\u003e\u003cimg alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n[comment]: \u003c\u003e (\u003cp align=\"center\"\u003e)\n\n[comment]: \u003c\u003e (    \u003ca href=\"https://pytorch.org/get-started/locally/\"\u003e\u003cimg alt=\"PyTorch\" src=\"https://img.shields.io/badge/-PyTorch-red?logo=pytorch\u0026labelColor=gray\"\u003e\u003c/a\u003e)\n\n[comment]: \u003c\u003e (    \u003ca href=\"https://pytorchlightning.ai/\"\u003e\u003cimg alt=\"Lightning\" src=\"https://img.shields.io/badge/code-Lightning-blueviolet\"\u003e\u003c/a\u003e)\n\n[comment]: \u003c\u003e (    \u003ca href=\"https://hydra.cc/\"\u003e\u003cimg alt=\"Conf: hydra\" src=\"https://img.shields.io/badge/conf-hydra-blue\"\u003e\u003c/a\u003e)\n\n[comment]: \u003c\u003e (    \u003ca href=\"https://wandb.ai/site\"\u003e\u003cimg alt=\"Logging: wandb\" src=\"https://img.shields.io/badge/logging-wandb-yellow\"\u003e\u003c/a\u003e)\n\n[comment]: \u003c\u003e (    \u003ca href=\"https://dvc.org/\"\u003e\u003cimg alt=\"Conf: hydra\" src=\"https://img.shields.io/badge/data-dvc-9cf\"\u003e\u003c/a\u003e)\n\n[comment]: \u003c\u003e (    \u003ca href=\"https://streamlit.io/\"\u003e\u003cimg alt=\"UI: streamlit\" src=\"https://img.shields.io/badge/ui-streamlit-orange\"\u003e\u003c/a\u003e)\n\n[comment]: \u003c\u003e (\u003c/p\u003e)\n\n\u003cp align=\"center\"\u003e\n    \u003ci\u003e\n        \"We demand rigidly defined areas of doubt and uncertainty.\"\n    \u003c/i\u003e\n\u003c/p\u003e\n\n\nGeneric template to bootstrap your [PyTorch](https://pytorch.org/get-started/locally/) project,\nread more in the [documentation](https://grok-ai.github.io/nn-template).\n\n\n[![asciicast](https://asciinema.org/a/475623.svg)](https://asciinema.org/a/475623)\n\n## Get started\n\nIf you already know [cookiecutter](https://github.com/cookiecutter/cookiecutter), just generate your project with:\n\n```bash\ncookiecutter https://github.com/grok-ai/nn-template\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOtherwise\u003c/summary\u003e\nCookiecutter manages the setup stages and delivers to you a personalized ready to run project.\n\nInstall it with:\n\u003cpre\u003e\u003ccode\u003epip install cookiecutter\n\u003c/code\u003e\u003c/pre\u003e\n\u003c/details\u003e\n\nMore details in the [documentation](https://grok-ai.github.io/nn-template/latest/getting-started/generation/).\n\n## Strengths\n\n- **Actually works for [research](https://grok-ai.github.io/nn-template/latest/papers/)**!\n- Guided setup to customize project bootstrapping;\n- Fast prototyping of new ideas, no need to build a new code base from scratch;\n- Less boilerplate with no impact on the learning curve (as long as you know the integrated tools);\n- Ensure experiments reproducibility;\n- Automatize via GitHub actions: testing, stylish documentation deploy, PyPi upload;\n- Enforce Python [best practices](https://grok-ai.github.io/nn-template/latest/features/bestpractices/);\n- Many more in the [documentation](https://grok-ai.github.io/nn-template/latest/features/nncore/);\n\n## Integrations\n\nAvoid writing boilerplate code to integrate:\n\n- [PyTorch Lightning](https://github.com/PyTorchLightning/pytorch-lightning), lightweight PyTorch wrapper for high-performance AI research.\n- [Hydra](https://github.com/facebookresearch/hydra), a framework for elegantly configuring complex applications.\n- [Hugging Face Datasets](https://huggingface.co/docs/datasets/index),a library for easily accessing and sharing datasets.\n- [Weights and Biases](https://wandb.ai/home), organize and analyze machine learning experiments. *(educational account available)*\n- [Streamlit](https://streamlit.io/), turns data scripts into shareable web apps in minutes.\n- [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), a fast, simple and downright gorgeous static site generator.\n- [DVC](https://dvc.org/doc/start/data-versioning), track large files, directories, or ML models. Think \"Git for data\".\n- [GitHub Actions](https://github.com/features/actions), to run the tests, publish the documentation and to PyPI automatically.\n- Python best practices for developing and publishing research projects.\n\n## Maintainers\n\n- Valentino Maiorca [@Flegyas](https://github.com/Flegyas)\n- Luca Moschella [@lucmos](https://github.com/lucmos)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrok-ai%2Fnn-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrok-ai%2Fnn-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrok-ai%2Fnn-template/lists"}