Metadata-Version: 2.1
Name: DeepMuon
Version: 1.23.51
Summary: Interdisciplinary Deep Learning Platform
Home-page: https://airscker.github.io/DeepMuon/
Author: Airscker/Yufeng Wang
Author-email: airscker@gmail.com
License: UNKNOWN
Keywords: Deep Learning,Searching Dark Matter,Direct and Simple
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
License-File: LICENSE.txt

<h1><center><img src="./Resources/DeepMuon.png" width='900px'></center></h1>

## Introduction

DeepMuon is a easy-using deep learning platform initially built for dark matter searching experiments. Up to now it has been a interdisciplinary deep learning platform. We are eager to provide advanced model training framework and excellent project management assistance.

Here we list out some available features of DeepMuon:

- **Single GPU** training， **Distributed Data Parallel** training and **Fully Sharded Distributed Parallel** training.
- Neural Network Hyperparameter Searching (NNHS)
- Gradient accumulation
- Gradient clipping
- Mixed precision training
- Double precision training
- Customize models
- Customize datasets
- Customize loss functions
- Tidy logging system
- Model interpretation
- Simple and direct tutorials

More details please refer to the home page of [DeepMuon](https://airscker.github.io/DeepMuon/).

## Installation (From source recommended)

```bash
git clone https://github.com/Airscker/DeepMuon.git
cd DeepMuon
pip install -v -e ./ --user
```

## CopyRight

> GNU AFFERO GENERAL PUBLIC LICENSE
>
> Project: DeepMuon
>
> Interdisciplinary Deep Learning Platform
>
> Author: Airscker/Yufeng Wang
>
> Contributors: Yufeng Wang, Shendong Su
>
> University of Science of Technology of China
>
> If you want to publish thesis using DeepMuon, please add bibliography:
>
> ```tex
> @misc{deepmuon,
>   author       = {Yufeng Wang},
>   title        = {DeepMuon: Interdisciplinary deep-learning platform},
>   year         = {2022},
>   publisher    = {GitHub},
>   journal      = {GitHub repository},
>   howpublished = {\url{https://airscker.github.io/DeepMuon}},
> }
> ```
> Copyright (C) 2023 by Airscker(Yufeng), All Rights Reserved.


