Commit 3e7c35d0 authored by nd-02110114's avatar nd-02110114
Browse files

📝 update docs

parent 9339e0d7
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -518,6 +518,7 @@ class JsonLoader(DataLoader):

  Dump the dataframe to the JSON file formatted as "records" in line delimited format and
  load the json file by JsonLoader.

  >>> import tempfile
  >>> import deepchem as dc
  >>> with tempfile.NamedTemporaryFile(mode='w') as tmpfile:
+28 −2
Original line number Diff line number Diff line
@@ -124,10 +124,13 @@ Graph Data
^^^^^^^^^^

These classes document the data classes for graph convolutions. 
We plan to simplify these classes into a joint data representation
for all graph convolutions in a future version of DeepChem,
We plan to simplify these classes (:code:`ConvMol`, :code:`MultiConvMol`, :code:`WeaveMol`)
into a joint data representation (:code:`GraphData`) for all graph convolutions in a future version of DeepChem,
so these APIs may not remain stable.

The graph convolution models which inherit :code:`KerasModel` depend on :code:`ConvMol`, :code:`MultiConvMol`, or :code:`WeaveMol`.
On the other hand, the graph convolution models which inherit :code:`TorchModel` depend on :code:`GraphData`.

.. autoclass:: deepchem.feat.mol_graphs.ConvMol
  :members:

@@ -141,3 +144,26 @@ so these APIs may not remain stable.

.. autoclass:: deepchem.feat.graph_data.GraphData
  :members:


Base Classes (for develop)
--------------------------

Dataset
^^^^^^^
The :code:`dc.data.Dataset` class is the abstract parent class for all
datasets. This class should never be directly initialized, but
contains a number of useful method implementations.

.. autoclass:: deepchem.data.Dataset
  :members:

DataLoader
^^^^^^^^^^

The :code:`dc.data.DataLoader` class is the abstract parent class for all
dataloaders. This class should never be directly initialized, but
contains a number of useful method implementations.

.. autoclass:: deepchem.data.DataLoader
  :members: