Skip to content

Commit

Permalink
Merge pull request #83 from deepskies/typos_versions
Browse files Browse the repository at this point in the history
Update version, fix depedencies
  • Loading branch information
voetberg authored Jul 9, 2024
2 parents 35a14ee + b8179a9 commit bfde9a8
Show file tree
Hide file tree
Showing 6 changed files with 475 additions and 701 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pytest

## Quickstart

[View the template yaml here for a minimially working example with our supplied sample data to get started.](https://github.com/deepskies/DeepDiagnostics/blob/main/config.yml.template)
[View the template yaml here for a minimally working example with our supplied sample data to get started.](https://github.com/deepskies/DeepDiagnostics/blob/main/config.yml.template)

### Pipeline
`DeepDiagnostics` includes a CLI tool for analysis.
Expand Down Expand Up @@ -53,11 +53,11 @@ It is encouraged, but not required.


``` py
from DeepDiagnostics.utils.configuration import Config
from DeepDiagnostics.model import SBIModel
from DeepDiagnostics.data import H5Data
from deepdiagnostics.utils.configuration import Config
from deepdiagnostics.model import SBIModel
from deepdiagnostics.data import H5Data

from DeepDiagnostics.plots import LocalTwoSampleTest, Ranks
from deepdiagnostics.plots import LocalTwoSampleTest, Ranks

Config({configuration_path})
model = SBIModel({model_path})
Expand Down Expand Up @@ -177,7 +177,7 @@ For this example, we will add a new metric, but an identicial workflow takes pla

1. Add the name and mapping to the submodule `__init__.py`.

##### `src/deepdiagonstics/metrics/__init__.py`
##### `src/deepdiagnostics/metrics/__init__.py`

``` py
...
Expand All @@ -193,7 +193,7 @@ Metrics = {

2. Add the name and defaults to the `Defaults.py`

##### `src/deepdiagonstics/utils/Defaults.py`
##### `src/deepdiagnostics/utils/Defaults.py`

``` py
Defaults = {
Expand All @@ -211,7 +211,7 @@ Defaults = {
##### `tests/test_metrics.py`

``` py
from deepdaigonstics.metrics import NewMetric
from deepdiagnostics.metrics import NewMetric

...

Expand All @@ -237,7 +237,7 @@ python3 -m pytest tests/test_metrics.py::test_newmetric
##### `docs/source/metrics.rst`

``` rst
from deepdaigonstics.metrics import NewMetric
from deepdiagnostics.metrics import NewMetric
.. _metrics:
Expand All @@ -248,7 +248,7 @@ Metrics
:members:
...
.. autoclass:: deepdiagonstics.metrics.newmetric.NewMetric
.. autoclass:: deepdiagnostics.metrics.newmetric.NewMetric
:members: calculate
.. bibliography::
Expand Down
Loading

0 comments on commit bfde9a8

Please sign in to comment.