PyTorch DNC 项目使用教程
1. 项目的目录结构及介绍
pytorch-dnc/
├── dnc/
│ ├── __init__.py
│ ├── controller.py
│ ├── memory.py
│ ├── util.py
│ └── ...
├── docs/
│ ├── README.md
│ └── ...
├── tasks/
│ ├── __init__.py
│ ├── task1.py
│ ├── task2.py
│ └── ...
├── test/
│ ├── __init__.py
│ ├── test_dnc.py
│ └── ...
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── README.rst
├── release.sh
├── requirements.txt
├── setup.cfg
└── setup.py
目录结构介绍
- dnc/: 包含项目的主要实现文件,如控制器、内存模块等。
- docs/: 包含项目的文档文件,如README.md等。
- tasks/: 包含项目的任务文件,如task1.py、task2.py等。
- test/: 包含项目的测试文件,如test_dnc.py等。
- .gitignore: Git忽略文件。
- .travis.yml: Travis CI配置文件。
- CHANGELOG.md: 项目更新日志。
- LICENSE: 项目许可证。
- README.md: 项目介绍文档。
- README.rst: 项目介绍文档(RST格式)。
- release.sh: 发布脚本。
- requirements.txt: 项目依赖文件。
- setup.cfg: 项目配置文件。
- setup.py: 项目安装脚本。
2. 项目的启动文件介绍
项目的启动文件通常是setup.py
,它负责项目的安装和配置。以下是setup.py
的基本内容:
from setuptools import setup, find_packages
setup(
name='pytorch-dnc',
version='0.1.0',
description='Differentiable Neural Computer (DNC) with PyTorch',
author='Jingwei Zhang',
author_email='jingweiz@github.com',
url='https://github.com/jingweiz/pytorch-dnc',
packages=find_packages(),
install_requires=[
'torch',
'visdom',
# 其他依赖
],
classifiers=[
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
],
)
启动文件介绍
- name: 项目名称。
- version: 项目版本。
- description: 项目描述。
- author: 项目作者。
- author_email: 作者邮箱。
- url: 项目仓库地址。
- packages: 需要包含的包。
- install_requires: 项目依赖。
- classifiers: 项目分类信息。
3. 项目的配置文件介绍
项目的配置文件通常是setup.cfg
,它包含了一些项目的配置信息。以下是setup.cfg
的基本内容:
[metadata]
name = pytorch-dnc
version = 0.1.0
description = Differentiable Neural Computer (DNC) with PyTorch
author = Jingwei Zhang
author_email = jingweiz@github.com
url = https://github.com/jingweiz/pytorch-dnc
license = MIT
[options]
packages = find:
install_requires =
torch
visdom
# 其他依赖
[options.packages.find]
where = .
[egg_info]
tag_build =
tag_date = 0
配置文件介绍
- [metadata]: 项目元数据信息。
- name: 项目名称。
- version: 项目版本。
- description: 项目描述。
- author: 项目作者。
- author_email: 作者邮箱。