torchdms documentation home¶
To do list¶
Todo
Developer Install via GitHub
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/installation.rst, line 13.)
Todo
pip
install (PyPi not working yet)
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/installation.rst, line 30.)
Todo
Provide some information on the required data format of torchdms
and perhaps a tutorial on how to go from a CSV file to a pickled object.
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/tutorials.rst, line 7.)
Todo
Prepping data for model fitting in torchdms.data
.
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/tutorials.rst, line 10.)
Todo
Creating models with torchdms.model
.
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/tutorials.rst, line 13.)
Todo
Training models with torchdms.analysis
and torchdms.loss
.
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/tutorials.rst, line 16.)
Todo
Evaluating model performance with torchdms.evaluation
and torchdms.plot
.
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/tutorials.rst, line 19.)
Todo
The link below is broken or private. We also need a demo of how to create the pickle file—Zorian has a notebook we could use?
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/tutorials.rst, line 28.)
Todo
Create a few tutorials on using the CLI and link to page.
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/introduction.rst, line 17.)
Todo
Create tutorials for key functionality in torchdms
API – planning on having notebooks as examples. Think about how to make this work nicely in the tutorials page.
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/docs/source/introduction.rst, line 22.)
Todo
much more documentation needed
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/analysis.py:docstring of torchdms.analysis.Analysis, line 3.)
Todo
much more documentation needed
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/analysis.py:docstring of torchdms.analysis.Analysis, line 3.)
Todo
model math markup, and schematic needed here
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.Escape, line 6.)
Todo
schematic image
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.FullyConnected, line 3.)
Todo
allowable activation function names?
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.FullyConnected, line 13.)
Todo
schematic image
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.Independent, line 4.)
Todo
allowable activation function names?
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.Independent, line 15.)
Todo
schematic image: https://user-images.githubusercontent.com/1173298/89943302-d4524d00-dbd2-11ea-827d-6ad6c238ff52.png
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.Conditional, line 8.)
Todo
schematic image
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.ConditionalSequential, line 3.)
Todo
schematic image: https://user-images.githubusercontent.com/1173298/89943302-d4524d00-dbd2-11ea-827d-6ad6c238ff52.png
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.Conditional, line 8.)
Todo
schematic image
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.ConditionalSequential, line 3.)
Todo
model math markup, and schematic needed here
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.Escape, line 6.)
Todo
schematic image
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.FullyConnected, line 3.)
Todo
allowable activation function names?
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.FullyConnected, line 13.)
Todo
schematic image
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.Independent, line 4.)
Todo
allowable activation function names?
(The original entry is located in /home/jared/MatsenGroup/Projects/torchdms/torchdms/torchdms/model.py:docstring of torchdms.model.Independent, line 15.)