什么是deepcom

在进行深度学习与通信领域的交叉研究时，有一些反复使用的算法与训练流程。但是现有的学习框架主要集中在网络的训练部分，对于通信领域的参数压缩与高效传输并没有较多前沿工具可以直接使用。因此我们推出python包deepcom（DEEP Learning & COMmunication），将核心通信算法与常规的训练方法进行封装，便于日后研究中快速调用。

项目主页：https://github.com/mh-lan/deepcom

本文主要对python包的结构进行简要介绍，同时对包的维护进行流程化的梳理，从而能够更标准化地直接调用。

包的结构

在包的制作上主要参考python官网的教程。准备好相关文件后，文件的目录树为

C:\USERS\DOUBL\DESKTOP\DLCOM
│  deepcom.py
│  LICENSE.txt
│  pyproject.toml
│  README.md
│  __init__.py
|  _version.py
│
├─dist
│      itpy-0.0.1-py3-none-any.whl
│      itpy-0.0.1.tar.gz
│
└─tests
        test.py

其中主要程序放在 deepcom.py文件中，调用时先利用pip进行安装

pip install deepcom

然后再python文件中进行相关函数的调用即可

import deepcom as dc
dc.func()

包的维护

准备工作

需要提前下载的两个模块

python -m pip install --upgrade build
python -m pip install --upgrade twine

修改对应内容

• 在deepcom.py当中修改原有代码

• 在pyproject.toml与_version.py当中修改版本号

• 在README.md当中修改功能简介与使用说明

• 上传修改后的源码至GitHub仓库:

制作包并上传

1. 切换到pyproject.toml所在的文件夹，运行

   python -m build
   

   会在dist文件夹生成两个文件作为制作的包。这两个包都可以用pip install命令直接安装。

2. 上传轮子到pypi

   python -m twine upload dist/*.whl
   

   此时会提示输入username和password，分别是__token__和token的具体值。

   为了不每次人工输入，也可以在家目录创建文件

   • Linux : ~/.pypirc
   • Windows： C:\Users\Username\.pypirc

   文件内容为

   [distutils]
   index-servers=pypi
   
   [pypi]
   repository = https://upload.pypi.org/legacy/
   username = __token__
   password = pypi-...