-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #58 from voetberg/doc_quickstart
Building documentation complete
- Loading branch information
Showing
11 changed files
with
92 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
Client | ||
======== | ||
|
||
.. autoclass:: DeepDiagnostics.Client | ||
.. automodule:: client | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,11 @@ | ||
Data | ||
====== | ||
|
||
.. autoclass:: DeepDiagnostics.data.data.Data | ||
.. autoclass:: data.data.Data | ||
:members: | ||
|
||
.. autoclass:: data.H5Data | ||
:members: | ||
|
||
.. autoclass:: data.PickleData | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
Metrics | ||
=========== | ||
|
||
.. autoclass:: DeepDiagnostics.metrics.metrics.Metrics | ||
.. autoclass:: metrics.metric.Metric | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,8 @@ | ||
Models | ||
======== | ||
======== | ||
|
||
.. autoclass:: models.model.Model | ||
:members: | ||
|
||
.. autoclass:: models.SBIModel | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
Plots | ||
======== | ||
|
||
.. autoclass:: DeepDiagnostics.plots.plots.Plots | ||
.. autoclass:: plots.Plots | ||
:members: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
Utils | ||
======= | ||
|
||
.. autoclass:: DeepDiagnostics.utils.config.Config | ||
:members: | ||
.. autoclass:: utils.config.Config | ||
:members: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
.. _metrics: | ||
|
||
Metrics | ||
========= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
.. _plots: | ||
|
||
Plots | ||
======= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,60 @@ | ||
Quickstart | ||
============ | ||
============ | ||
|
||
Installation | ||
-------------- | ||
|
||
* From PyPi | ||
.. code-block:: console | ||
pip install DeepDiagnostics | ||
* From Source | ||
.. code-block:: console | ||
git clone https://github.com/deepskies/DeepDiagnostics/ | ||
pip install poetry | ||
poetry shell | ||
poetry install | ||
Pipeline | ||
--------- | ||
|
||
`DeepDiagnostics` includes a CLI tool for analysis. | ||
* To run the tool using a configuration file: | ||
|
||
.. code-block:: console | ||
diagnose --config {path to yaml} | ||
* To use defaults with specific models and data: | ||
|
||
.. code-block:: console | ||
diagnose --model_path {model pkl} --data_path {data pkl} [--simulator {sim name}] | ||
Additional arguments can be found using ``diagnose -h`` | ||
|
||
Standalone | ||
---- | ||
|
||
`DeepDiagnostics` comes with the option to run different plots and metrics independently. | ||
This requires setting a configuration file ahead of time, and then running the plots. | ||
|
||
All plots and metrics can be found in :ref:`plots<plots>` and :ref:`metrics<metrics>`. | ||
|
||
|
||
|
||
.. code-block:: python | ||
from DeepDiagnostics.utils.configuration import Config | ||
from DeepDiagnostics.model import SBIModel | ||
from DeepDiagnostics.data import H5Data | ||
from DeepDiagnostics.plots import ... | ||
Config({configuration_path}) | ||
model = SBIModel({model_path}) | ||
data = H5Data({data_path}) | ||
{Plot of choice} |