julius/prototorch
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update setup.py and README.md

Browse Source
This commit is contained in:
Jensun Ravichandran 2021-02-10 17:02:02 +01:00
parent a55320a65b
commit 4c7c9cc34a
2 changed files with 60 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -28,15 +28,19 @@ pip install -U prototorch
```
To also install the extras, use
```bash
pip install -U prototorch[datasets,examples,tests]
pip install -U prototorch[all]
```
*Note: If you're using [ZSH](https://www.zsh.org/), the square brackets `[ ]`
have to be escaped like so: `\[\]`, making the install command `pip install -U
prototorch\[all\]`.*
To install the bleeding-edge features and improvements:
```bash
git clone https://github.com/si-cim/prototorch.git
git checkout dev
cd prototorch
pip install -e .
pip install -e .[all]
```
## Documentation

88
setup.py
View File

@ -3,48 +3,68 @@
from setuptools import setup
from setuptools import find_packages
PROJECT_URL = 'https://github.com/si-cim/prototorch'
DOWNLOAD_URL = 'https://github.com/si-cim/prototorch.git'
PROJECT_URL = "https://github.com/si-cim/prototorch"
DOWNLOAD_URL = "https://github.com/si-cim/prototorch.git"
with open('README.md', 'r') as fh:
with open("README.md", "r") as fh:
long_description = fh.read()
setup(name='prototorch',
version='0.1.1-rc0',
description='Highly extensible, GPU-supported '
'Learning Vector Quantization (LVQ) toolbox '
'built using PyTorch and its nn API.',
INSTALL_REQUIRES = [
"torch>=1.3.1",
"torchvision>=0.5.0",
"numpy>=1.9.1",
]
DOCS = [
"recommonmark",
"sphinx",
"sphinx_rtd_theme",
"sphinxcontrib-katex",
]
DATASETS = [
"requests",
"tqdm",
]
EXAMPLES = [
"sklearn",
"matplotlib",
]
TESTS = ["pytest"]
ALL = DOCS + DATASETS + EXAMPLES + TESTS
setup(name="prototorch",
version="0.1.1-rc0",
description="Highly extensible, GPU-supported "
"Learning Vector Quantization (LVQ) toolbox "
"built using PyTorch and its nn API.",
long_description=long_description,
long_description_content_type='text/markdown',
author='Jensun Ravichandran',
author_email='jjensun@gmail.com',
long_description_content_type="text/markdown",
author="Jensun Ravichandran",
author_email="jjensun@gmail.com",
url=PROJECT_URL,
download_url=DOWNLOAD_URL,
license='MIT',
install_requires=[
'torch>=1.3.1',
'torchvision>=0.5.0',
'numpy>=1.9.1',
],
license="MIT",
install_requires=INSTALL_REQUIRES,
extras_require={
'datasets': ['requests', 'tqdm'],
'examples': [
'sklearn',
'matplotlib',
],
'tests': ['pytest'],
"docs": DOCS,
"datasets": DATASETS,
"examples": EXAMPLES,
"tests": TESTS,
"all": ALL,
},
classifiers=[
'Development Status :: 2 - Pre-Alpha', 'Environment :: Console',
'Intended Audience :: Developers', 'Intended Audience :: Education',
'Intended Audience :: Science/Research',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Operating System :: OS Independent',
'Topic :: Scientific/Engineering :: Artificial Intelligence',
'Topic :: Software Development :: Libraries',
'Topic :: Software Development :: Libraries :: Python Modules'
"Development Status :: 2 - Pre-Alpha",
"Environment :: Console",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Operating System :: OS Independent",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Software Development :: Libraries",
"Topic :: Software Development :: Libraries :: Python Modules",
],
packages=find_packages())