Skip to content

Commit

Permalink
Merge pull request #2000 from nd-02110114/fix-docs
Browse files Browse the repository at this point in the history
Fix doctest error and add docs build status in README
  • Loading branch information
Bharath Ramsundar committed Jul 10, 2020
2 parents 80552cb + 80986f3 commit 3810dd1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -43,16 +44,15 @@ DeepChem currently supports Python 3.5 through 3.7 and requires these packages o
### Soft Requirements

DeepChem has a number of "soft" requirements.
If you face `ImportError: No module named XXXX`, you may need to install some packages.
If you face some errors like `ImportError: No module named XXXX`, you may need to install some packages.

Please check [the document](https://deepchem.readthedocs.io/en/latest/requirements.html##soft-requirements) about the details of soft requirements.
Please check [the document](https://deepchem.readthedocs.io/en/latest/requirements.html##soft-requirements) about soft requirements.

## Installation

### Stable version

**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.**
**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.**

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

Expand All @@ -70,7 +70,7 @@ conda install -y -c conda-forge rdkit deepchem==2.3.0

### Nightly build version

You install the nightly build version via pip. Nightly version is built by the HEAD of DeepChem.
You install the nightly build version via pip. The nightly version is built by the HEAD of DeepChem.

```bash
pip install tensorflow==2.2
Expand Down
2 changes: 1 addition & 1 deletion deepchem/molnet/load_function/load_dataset_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import deepchem
from deepchem.feat import Featurizer
from deepchem.trans import Transformer
from deepchem.split.splitters import Splitter
from deepchem.splits.splitters import Splitter
from deepchem.molnet.defaults import get_defaults

from typing import List, Tuple, Dict, Optional
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Nightly build version
---------------------

You install the nightly build version via pip.
Nightly version is built by the HEAD of DeepChem.
The nightly version is built by the HEAD of DeepChem.

.. code-block:: bash
Expand Down

0 comments on commit 3810dd1

Please sign in to comment.