Commit 51168267 authored by nd-02110114's avatar nd-02110114
Browse files

add test for tutorials docs

parent bfe78d05
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -44,6 +44,7 @@ script:
  - if [[ "$CHECK_ONLY_DOCS" == "true" ]]; then
      cd docs && pip install -r requirements.txt;
      make clean html;
      make doctest_tutorials;
      make doctest_examples;
      travis_terminate $?;
    fi
+3 −1
Original line number Diff line number Diff line
@@ -15,9 +15,11 @@ help:
.PHONY: help Makefile

doctest_examples:
	export PYTHONWARNINGS= 
	@$(SPHINXBUILD) -M doctest "$(SOURCEDIR)" "$(BUILDDIR)" source/get_started/examples.rst;

doctest_tutorials:
	@$(SPHINXBUILD) -M doctest "$(SOURCEDIR)" "$(BUILDDIR)" source/get_started/tutorials.rst;

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
+1 −1
Original line number Diff line number Diff line
@@ -167,7 +167,7 @@ If you are using the Windows and the PowerShell:


.. _`DeepChem Tutorials`: https://github.com/deepchem/deepchem/tree/master/examples/tutorials
.. _`forum post`: https://forum.deepchem.io/t/getting-deepchem-running-in-colab/81/7?u=nd-02110114
.. _`forum post`: https://forum.deepchem.io/t/getting-deepchem-running-in-colab/81/7
.. _`DockerHub`: https://hub.docker.com/repository/docker/deepchemio/deepchem
.. _`docker/conda-forge`: https://github.com/deepchem/deepchem/tree/master/docker/conda-forge
.. _`docker/master`: https://github.com/deepchem/deepchem/tree/master/docker/master
+6 −6
Original line number Diff line number Diff line
@@ -124,11 +124,11 @@ We'll show you the example about the usage of splitters.

.. doctest::

   >>> splitter = dc.split.RandomSplitter()
   >>> splitter = dc.splits.RandomSplitter()
   >>> # split 5 datapoints in the ratio of train:valid:test = 3:1:1
   >>> train_dataset, valid_dataset, test_dataset = splitter.split(
   >>>   dataset=dataset, frac_train=0.6, frac_valid=0.2, frac_valid=0.2
   >>> )
   >>> train_dataset, valid_dataset, test_dataset = splitter.train_valid_test_split(
   ...   dataset=dataset, frac_train=0.6, frac_valid=0.2, frac_test=0.2
   ... )
   >>> len(train_dataset)
   >>> 3
   >>> len(valid_dataset)
@@ -161,10 +161,10 @@ We'll show you the example about the usage of models.
   >>> model.fit(train_dataset)
   >>> valid_preds = model.predict(valid_dataset)
   >>> valid_preds.shape
   (1, 1)
   (1,)
   >>> test_preds = model.predict(test_dataset)
   >>> test_preds.shape
   (1, 1)
   (1,)

Here, we've used the :code:`SklearnModel` and trained the model.
Even if you want to train a deep learning model which is implemented
+2 −2
Original line number Diff line number Diff line
@@ -69,7 +69,7 @@ Then open your python and try running.
    import deepchem

.. _`DeepChem Tutorials`: https://github.com/deepchem/deepchem/tree/master/examples/tutorials
.. _`forum post`: https://forum.deepchem.io/t/getting-deepchem-running-in-colab/81/7?u=nd-02110114
.. _`forum post`: https://forum.deepchem.io/t/getting-deepchem-running-in-colab/81/7

About Us
--------
@@ -94,7 +94,7 @@ To listen in, please email X.Y@gmail.com, where X=bharath and Y=ramsundar to int

   get_started/installation
   get_started/requirements
   get_started/tutorial
   get_started/tutorials
   get_started/examples

.. toctree::