Metadata-Version: 2.1
Name: deepcom
Version: 0.1.0
Summary: Research tools for communication-efficient deep learning
Project-URL: Homepage, https://github.com/mh-lan/deepcom
Project-URL: Bug Tracker, https://github.com/mh-lan/deepcom/issues
Author-email: Muhang Lan <mhlan@mail.ustc.edu.cn>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

Research tools for communication-efficient deep learning, developed by Muhang Lan at USTC.

Latest version: 0.1.0

# Installation

Install using pip

```shell
pip install deepcom
```

Check version number

```python
import deepcom as dc
print(dc.__version__)
```

# Function list

## Basic tools

- Batch processing with enumerating given argument values: ```python -m deepcom config.json```

### Deep learning perspective

- Convert model parameters to a numpy array: ```model2params()```

- Load a numpy array as model parameters: ```params2model()```

### Communication perspective

- Calculating mutual information: ```mutual_info()```

## Compression for training model

## Compression for post-training model

- SuRP algorithm as a sparse compression for Laplacian sequence: ```surp_algorithm()```
