Commit 429e3fb5 authored by peastman's avatar peastman
Browse files

Resolved conflicts

parents 6e3b05d9 344b1ff7
Loading
Loading
Loading
Loading
+12 −0
Original line number Diff line number Diff line
### Template for pull request contributing a new dataset to MoleculeNet
Category: {Quantum Mechanics, Materials Science, Physical Chemistry, Biophysics, Physiology}  
Dataset: {short name identifying dataset}  
Data Type: {SMILES, 3D coordinates}  
Task Type: {Regression, Classification}  
\# Tasks: {integer}  
\# Compounds: {integer}  
Rec - Split†: {Random, Stratified, Scaffold, Time}  
Rec - Metric†: {MAE, RMSE, R^2, PRC-AUC, ROC-AUC}
Reference: {MLA style reference.}

† For details on recommended split types and metrics, refer to the [MolNet paper](https://arxiv.org/abs/1703.00564).
 No newline at end of file
+7 −6
Original line number Diff line number Diff line
@@ -21,22 +21,21 @@ install:
- if [[ "$TRAVIS_OS_NAME" == "windows" ]]; then choco install miniconda3 --params="'/JustMe
  /AddToPath:1'"; export PATH="/c/tools/miniconda3/:/c/tools/miniconda3/Scripts:/c/tools/miniconda3/Library/bin:$PATH";
  source /c/tools/miniconda3/etc/profile.d/conda.sh; fi
- hash -r
- conda config --set always_yes yes --set changeps1 no
- conda update -q conda
- conda config --add channels http://conda.binstar.org/omnia
- bash scripts/install_deepchem_conda.sh deepchem
- conda activate deepchem
- pip install yapf==0.22.0
- pip install coveralls
- python setup.py install
- conda install mypy
- pip install coveralls yapf==0.22.0
script:
- pytest -m "not slow" --cov=deepchem deepchem
- if [ $TRAVIS_PYTHON_VERSION == '3.7' ]; then find ./deepchem | grep .py$ |xargs
  python -m doctest -v; fi
- if [ $TRAVIS_PYTHON_VERSION == '3.7' ]; then
  find ./deepchem -name "*.py" ! -name '*load_dataset_template.py' | xargs python -m doctest -v; fi
- bash devtools/travis-ci/test_format_code.sh
- mypy -p deepchem --ignore-missing-imports
- if [ $TRAVIS_PYTHON_VERSION == '3.7' ]; then
  cd docs && pip install -r requirements.txt && make clean html && cd ..; fi
after_success:
- echo $TRAVIS_SECURE_ENV_VARS
- coveralls
@@ -46,3 +45,5 @@ deploy:
  password:
    secure: b67LO8VZcoKEWo7gDlFdjS1yKUavCt578uAuXPyW6f+e+Tk/sEQRdkx1VYoZlQdfZQo8u4q+E3W184T+/j6ht65/cdy/HYH57LCQySjF/MY2M9+/lcP45aY7Z0F2QHeY9QgpRc8gKthGzgM/bHj2glxlEvT1diItEEoGqE2x/fw1K25cNOni08E4hqz0HPY1SXVwd8/9Z/t1YasrBcOjtJ8kcbyjnmeyhjfkaV/aTaAzuqh2MlqZTSz3dhwsBrZfZp86+8T2TgcoDSuIxCwb777QKW1QlvNyLEKlnfateKMYqrrP65oHrxXEEcHd/N3IH28Bz9wVnENjHLkGJ0vXyXyEWcJFe+V6T0k/8NkZamU4SZE5BM4v6mOdThs4l54vuFajctHDeGgIDjL55MfkDmkKd5lAvlWPwrdw8DERsmqetUfZ/TG7FE6/MT1puu2ffu3A9Ivcch5T46pojIggDWHHn9hUsc6iD3Ov7rVqd024Lzm9V8wXiDYU9EMqAu5lJQRIOO/hnr8Gn6zYRCE1n29MKuNJwauSHfdV/mBTRyOjZyWHSGNaiPw2hqE3tZrrIN4koEYaZiERRVnmVt8wMUTj40YglosTHYpL91SkDH/ResX1rtHKs4Am+R+MmcWULTUQ7UwEtqlsa3nVxTK9gfmJ0nX8Jhjtl2iRhVg5PP8=
  edge: true
  on:
    condition: $TRAVIS_OS_NAME = linux && $TRAVIS_PYTHON_VERSION = 3.7

MANIFEST.in

deleted100644 → 0
+0 −2
Original line number Diff line number Diff line
prune datasets
prune examples
+30 −135
Original line number Diff line number Diff line
@@ -2,10 +2,11 @@

[![Build Status](https://travis-ci.org/deepchem/deepchem.svg?branch=master)](https://travis-ci.org/deepchem/deepchem)
[![Coverage Status](https://coveralls.io/repos/github/deepchem/deepchem/badge.svg?branch=master)](https://coveralls.io/github/deepchem/deepchem?branch=master)
[![Documentation Status](https://readthedocs.org/projects/deepchem/badge/?version=latest)](https://deepchem.readthedocs.io/en/latest/?badge=latest)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/deepchem/badges/version.svg)](https://anaconda.org/conda-forge/deepchem)
[![PyPI version](https://badge.fury.io/py/deepchem.svg)](https://badge.fury.io/py/deepchem)

[Website](https://deepchem.io/) | [Documentation (master)](https://deepchem.readthedocs.io/en/latest/) | [Colab Tutorial](https://github.com/deepchem/deepchem/tree/master/examples/tutorials) | [Discussion Forum](https://forum.deepchem.io/) | [Gitter](https://gitter.im/deepchem/Lobby)
[Website](https://deepchem.io/) | [Documentation](https://deepchem.readthedocs.io/en/latest/) | [Colab Tutorial](https://github.com/deepchem/deepchem/tree/master/examples/tutorials) | [Discussion Forum](https://forum.deepchem.io/) | [Gitter](https://gitter.im/deepchem/Lobby)

DeepChem aims to provide a high quality open-source toolchain
that democratizes the use of deep-learning in drug discovery,
@@ -15,11 +16,10 @@ materials science, quantum chemistry, and biology.

- [Requirements](#requirements)
- [Installation](#installation)
  - [Install latest package with conda](#install-via-conda-recommendation)
  - [Install latest package with pip (WIP)](#install-via-pip-wip)
  - [Install from source](#install-from-source)
  - [Install using a Docker](#install-using-a-docker)
- [FAQ and Troubleshooting](#faq-and-troubleshooting)
  - [Stable version](#stable-version)
  - [Nightly build version](#nightly-build-version)
  - [Docker](#docker)
  - [From source](#from-source)
- [Getting Started](#getting-started)
- [Contributing to DeepChem](/CONTRIBUTING.md)
  - [Code Style Guidelines](/CONTRIBUTING.md#code-style-guidelines)
@@ -30,7 +30,7 @@ materials science, quantum chemistry, and biology.

## Requirements

DeepChem requires these packages on any condition.
DeepChem currently supports Python 3.5 through 3.7 and requires these packages on any condition.

- [joblib](https://pypi.python.org/pypi/joblib)
- [NumPy](https://numpy.org/)
@@ -43,109 +43,49 @@ DeepChem requires these packages on any condition.

### Soft Requirements

DeepChem has a number of "soft" requirements. These are packages which are needed for various submodules of DeepChem but not for the package as a whole.

- [BioPython](https://biopython.org/wiki/Documentation)
- [OpenAI Gym](https://gym.openai.com/)
- [matminer](https://hackingmaterials.lbl.gov/matminer/)
- [MDTraj](http://mdtraj.org/)
- [NetworkX](https://networkx.github.io/documentation/stable/index.html)
- [OpenMM](http://openmm.org/)
- [PDBFixer](https://github.com/pandegroup/pdbfixer)
- [Pillow](https://pypi.org/project/Pillow/)
- [pyGPGO](https://pygpgo.readthedocs.io/en/latest/)
- [Pymatgen](https://pymatgen.org/)
- [PyTorch](https://pytorch.org/)
- [RDKit](http://www.rdkit.org/docs/Install.html)
- [simdna](https://github.com/kundajelab/simdna)
- [XGBoost](https://xgboost.readthedocs.io/en/latest/)
- [Weights & Biases](https://docs.wandb.com/)
- [Tensorflow Probability](https://www.tensorflow.org/probability)
DeepChem has a number of "soft" requirements.  
If you face some errors like `ImportError: No module named XXXX`, you may need to install some packages.

## Installation

### Install via conda (Recommendation)
Please check [the document](https://deepchem.readthedocs.io/en/latest/requirements.html##soft-requirements) about soft requirements.

RDKit is a soft requirement package, but many useful methods like molnet depend on it.
If you use conda, we recommend installing RDKit with deepchem.
## Installation

`deepchem>=2.4.0`
### Stable version

Coming soon...
**Caution!! : The latest stable version was published nearly a year ago. If you are a pip user or you face some errors, we recommend the nightly build version.**

`deepchem<2.4.0`
RDKit is a soft requirement package, but many useful methods like molnet depend on it. We recommend installing RDKit with deepchem.

```bash
pip install tensorflow==1.14
conda install -c rdkit -c conda-forge rdkit deepchem==2.3.0
conda install -y -c conda-forge rdkit deepchem==2.3.0
```

If you want GPU support:

```bash
pip install tensorflow-gpu==1.14
conda install -c rdkit -c conda-forge rdkit deepchem==2.3.0
conda install -y -c conda-forge rdkit deepchem==2.3.0
```

### Install via pip (WIP)

You are able to try to install deepchem via pip using the following command.  
However, pip installation is under development, so this command may not work well.
### Nightly build version

`deepchem>=2.4.0`

Coming soon...

`deepchem<2.4.0`
You install the nightly build version via pip. The nightly version is built by the HEAD of DeepChem.

```bash
pip install pandas pillow scikit-learn==0.22 tensorflow==1.14 deepchem==2.2.1.dev54
pip install tensorflow==2.2
pip install --pre deepchem
```

If you want GPU support:

```bash
pip install pandas pillow scikit-learn==0.22 tensorflow-gpu==1.14 deepchem==2.2.1.dev54
```

### Install from source

You can install deepchem in a new conda environment using the conda commands in `scripts/install_deepchem_conda.sh.` Installing via this script will ensure that you are **installing from the source**.
The following script requires `conda>=4.4` because it uses the `conda activate` command. (Please see the detail from [here](https://github.com/conda/conda/blob/a4c4feae404b2b378e106bd25f62cc8be15c768f/CHANGELOG.md#440-2017-12-20))

First, please clone the deepchem repository from GitHub.
RDKit is a soft requirement package, but many useful methods like molnet depend on it. We recommend installing RDKit with deepchem if you use conda.

```bash
git clone https://github.com/deepchem/deepchem.git
cd deepchem
conda install -y -c conda-forge rdkit
```

Then, execute the shell script.

```bash
bash scripts/install_deepchem_conda.sh deepchem
```

If you are using the Windows and the PowerShell:

```ps1
.\scripts\install_deepchem_conda.ps1 deepchem
```

Before activating deepchem environment, make sure conda has been initialized.  
Check if there is a `(base)` in your command line. If not, use `conda init <YOUR_SHELL_NAME>` to activate it, then:

```bash
conda activate deepchem
python setup.py install
pytest -m "not slow" deepchem # optional
```

Check [this link](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) for more information about the installation of conda environments.

### Install using a Docker
### Docker

If you want to install using a docker, you can pull two kinds of images.  
If you want to install deepchem using a docker, you can pull two kinds of images.  
DockerHub : https://hub.docker.com/repository/docker/deepchemio/deepchem

- `deepchemio/deepchem:x.x.x`
@@ -157,64 +97,19 @@ DockerHub : https://hub.docker.com/repository/docker/deepchemio/deepchem
  - The latest image is built every time we commit to the master branch
  - Dockerfile is put in `docker/master` directory

First, you pull the image you want to use.
You pull the image like this.

```bash
docker pull deepchemio/deepchem:2.3.0
```

Then, you create a container based on the image.
If you want to know docker usages with deepchem in more detail, please check [the document](https://deepchem.readthedocs.io/en/latest/installation.html#docker).

```bash
docker run --rm -it deepchemio/deepchem:2.3.0
```

If you want GPU support:

```bash
# If nvidia-docker is installed
nvidia-docker run --rm -it deepchemio/deepchem:2.3.0
docker run --runtime nvidia --rm -it deepchemio/deepchem:2.3.0

# If nvidia-container-toolkit is installed
docker run --gpus all --rm -it deepchemio/deepchem:2.3.0
```

You are now in a docker container which deepchem was installed. You can start playing with it in the command line.

```
(deepchem) root@xxxxxxxxxxxxx:~/mydir# python
Python 3.6.10 |Anaconda, Inc.| (default, May  8 2020, 02:54:21)
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import deepchem as dc
```
### From source

If you want to check the tox21 benchmark:
If you try install all soft dependencies at once or contribute to deepchem, we recommend you should install deepchem from source.

```bash
(deepchem) root@xxxxxxxxxxxxx:~/mydir# wget https://raw.githubusercontent.com/deepchem/deepchem/master/examples/benchmark.py
(deepchem) root@xxxxxxxxxxxxx:~/mydir# python benchmark.py -d tox21 -m graphconv -s random
```

## FAQ and Troubleshooting

1. DeepChem currently supports Python 3.5 through 3.7, and is supported on 64 bit Linux and Mac OSX. Note that DeepChem is not currently maintained for older versions of Python or with other operating systems.
2. Question: I'm seeing some failures in my test suite having to do with MKL
   `Intel MKL FATAL ERROR: Cannot load libmkl_avx.so or libmkl_def.so.`

   Answer: This is a general issue with the newest version of `scikit-learn` enabling MKL by default. This doesn't play well with many linux systems. See [BVLC/caffe#3884](https://github.com/BVLC/caffe/issues/3884) for discussions. The following seems to fix the issue

   ```bash
   conda install nomkl numpy scipy scikit-learn numexpr
   conda remove mkl mkl-service
   ```

3. Note that when using Ubuntu 16.04 server or similar environments, you may need to ensure libxrender is provided via e.g.:

```bash
sudo apt-get install -y libxrender-dev
```
Please check [this introduction](https://deepchem.readthedocs.io/en/latest/installation.html#from-source).

## Getting Started

@@ -248,4 +143,4 @@ To cite this book, please use this bibtex entry:

## Version

2.3.0
2.4.0-rc
Loading