Skip to content

Commit

Permalink
Added PyPI/pip-installable package 'thermostat-datasets'.
Browse files Browse the repository at this point in the history
  • Loading branch information
nfelnlp committed Jul 3, 2021
1 parent d695cc9 commit 57aeca1
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,17 @@ __Thermostat: A Large Collection of NLP Model Explanations and Analysis Tools.__

## Installation

### With pip (coming soon!)
### With pip

[![PyPI](https://img.shields.io/pypi/v/thermostat-datasets?style=flat-square)](https://pypi.org/project/thermostat-datasets/)

```bash
pip install thermostat-datasets
```




## Usage

Downloading a dataset requires just two lines of code:
Expand Down
52 changes: 52 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
from setuptools import find_packages, setup

REQUIRED_PKGS = [
"captum>=0.3",
"datasets>=1.5",
"jsonnet",
"numpy>=1.20",
"overrides",
"pandas",
"protobuf",
"pytorch-ignite",
"scipy",
"sentencepiece",
"sklearn",
"spacy>=3.0",
"torch",
"tqdm>=4.49",
"transformers>=4.5",
]

setup(
name="thermostat-datasets",
version="1.0.0", # expected format is one of x.y.z.dev0, or x.y.z.rc1 or x.y.z (no to dashes, yes to dots)
description="Collection of NLP model explanations and accompanying analysis tools",
long_description="Thermostat is a large collection of NLP model explanations and accompanying analysis tools. "
"Combines explainability methods from the captum library with Hugging Face's datasets and "
"transformers. Mitigates repetitive execution of common experiments in Explainable NLP and thus "
"reduces the environmental impact and financial roadblocks. Increases comparability and "
"replicability of research. Reduces the implementational burden.",
author="DFKI-NLP",
author_email="nils.feldhus@dfki.de",
url="https://github.com/DFKI-NLP/thermostat",
download_url="https://github.com/DFKI-NLP/thermostat/tags",
license="Apache 2.0",
package_dir={"": "src"},
packages=find_packages(where="src"),
install_requires=REQUIRED_PKGS,
classifiers=[
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
],
keywords="explainability heatmaps feature-attribution natural-language-processing",
zip_safe=False, # Required for mypy to find the py.typed file
)

0 comments on commit 57aeca1

Please sign in to comment.