Unverified Commit 3810dd10 authored by Bharath Ramsundar's avatar Bharath Ramsundar Committed by GitHub
Browse files

Merge pull request #2000 from nd-02110114/fix-docs

Fix doctest error and add docs build status in README
parents 80552cbb 80986f3f
Loading
Loading
Loading
Loading
+6 −6
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,
@@ -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.

@@ -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
+1 −1
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@ import logging
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
+1 −1
Original line number Diff line number Diff line
@@ -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