template

📘 Documentation | 🤔 Reporting Issues

📄 Table of Contents

• template
  • 📄 Table of Contents
  • 📖 Introduction 🔝
  • 🛠️ Installation 🔝
  • 👨‍🏫 Get Started 🔝
  • 📘 Documentation 🔝
  • 🙌 Contributing 🔝
  • 🎫 License 🔝
  • 🖊️ Citation 🔝
  • Acknowledgement

📖 Introduction 🔝

template is an open source template.

🛠️ Installation 🔝

Before installing template, please ensure that PyTorch has been successfully installed following the official guide.

Install template

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

👨‍🏫 Get Started 🔝

How to start template.

📘 Documentation 🔝

For detailed user guides and advanced guides, please refer to our Documentation:

• Get Started for get started.

🙌 Contributing 🔝

We appreciate all contributions to improve clshub. Please refer to CONTRIBUTING.md for the contributing guideline.

🎫 License 🔝

This project is released under the Apache 2.0 license.

🖊️ Citation 🔝

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.

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

• OpenMMLab
• 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}
}