https://github.com/okotaku/template

template repo
https://github.com/okotaku/template

Last synced: 24 days ago
JSON representation

template repo

• Host: GitHub
• URL: https://github.com/okotaku/template
• Owner: okotaku
• License: apache-2.0
• Created: 2023-03-13T08:56:17.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-20T00:14:21.000Z (7 months ago)
• Last Synced: 2024-04-20T01:28:24.485Z (7 months ago)
• Language: Python
• Size: 421 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# template

[![build](https://github.com/okotaku/template/actions/workflows/build.yml/badge.svg)](https://github.com/okotaku/template/actions/workflows/build.yml)

[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://template.readthedocs.io/en/latest/)

[![license](https://img.shields.io/github/license/okotaku/template.svg)](https://github.com/okotaku/template/blob/main/LICENSE)

[![open issues](https://isitmaintained.com/badge/open/okotaku/template.svg)](https://github.com/okotaku/template/issues)

[![Linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)

[📘 Documentation](https://template0.readthedocs.io/en/latest/) |

[🤔 Reporting Issues](https://github.com/okotaku/template/issues/new/choose)

## 📄 Table of Contents

- [template](#template)

  - [📄 Table of Contents](#-table-of-contents)

  - [📖 Introduction 🔝](#-introduction-)

  - [🛠️ Installation 🔝](#️-installation-)

  - [👨‍🏫 Get Started 🔝](#-get-started-)

  - [📘 Documentation 🔝](#-documentation-)

  - [🙌 Contributing 🔝](#-contributing-)

  - [🎫 License 🔝](#-license-)

  - [🖊️ Citation 🔝](#️-citation-)

  - [Acknowledgement](#acknowledgement)

## 📖 Introduction [🔝](#-table-of-contents)

template is an open source template.

## 🛠️ Installation [🔝](#-table-of-contents)

Before installing template, please ensure that PyTorch has been successfully installed following the [official guide](https://pytorch.org/get-started/locally/).

Install template

```

pip install git+https://github.com/okotaku/template.git

```

## 👨‍🏫 Get Started [🔝](#-table-of-contents)

How to start template.

## 📘 Documentation [🔝](#-table-of-contents)

For detailed user guides and advanced guides, please refer to our [Documentation](https://template0.readthedocs.io/en/latest/):

- [Get Started](https://template0.readthedocs.io/en/latest/get_started.html) for get started.

## 🙌 Contributing [🔝](#-table-of-contents)

We appreciate all contributions to improve clshub. Please refer to [CONTRIBUTING.md](https://github.com/open-mmlab/mmpretrain/blob/main/CONTRIBUTING.md) for the contributing guideline.

## 🎫 License [🔝](#-table-of-contents)

This project is released under the [Apache 2.0 license](LICENSE).

## 🖊️ Citation [🔝](#-table-of-contents)

If Modules is helpful to your research, please cite it as below.

```

@misc{modules2023,

    title = {{Modules}: XXX},

    author = {{Modules Contributors}},

    howpublished = {\url{https://github.com/okotaku/template}},

    year = {2023}

}

```

## Acknowledgement

This repo borrows the architecture design and part of the code from [mmengine](https://github.com/open-mmlab/mmengine).

Also, please check the following openmmlab projects and the corresponding Documentation.

- [OpenMMLab](https://openmmlab.com/)

- [MMEngine](https://github.com/open-mmlab/mmengine): OpenMMLab foundational library for training deep learning models.

```

@article{mmengine2022,

  title   = {{MMEngine}: OpenMMLab Foundational Library for Training Deep Learning Models},

  author  = {MMEngine Contributors},

  howpublished = {\url{https://github.com/open-mmlab/mmengine}},

  year={2022}

}

```