Skip to content

Commit

Permalink
fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
mastoffel committed Nov 27, 2024
1 parent a8828d5 commit 9fd28ff
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AutoEmulate <a href="https://alan-turing-institute.github.io/autoemulate/"><img src="misc/AE_logo_final.png" align="right" height="138" /></a>
# AutoEmulate <a href="https://alan-turing-institute.github.io/autoemulate/"><img src="https://raw.githubusercontent.com/alan-turing-institute/autoemulate/logo/misc/AE_logo_final.png" align="right" height="138" /></a>

![CI](https://github.com/alan-turing-institute/autoemulate/actions/workflows/ci.yaml/badge.svg)
[![codecov](https://codecov.io/gh/alan-turing-institute/autoemulate/graph/badge.svg?token=XD1HXQUIGK)](https://codecov.io/gh/alan-turing-institute/autoemulate)
Expand All @@ -19,7 +19,7 @@ There's lots of development at the moment, so we recommend installing the most c
pip install git+https://github.com/alan-turing-institute/autoemulate.git
```

There's also a release onPyPI:
There's also a release on PyPI:

```bash
pip install autoemulate
Expand All @@ -46,16 +46,16 @@ lhd = LatinHypercube([(-5., 1.), (0., 1000.)])
X = lhd.sample(100)
y = np.array([simulate_projectile(x) for x in X])

# compare emulator models
# compare emulators
ae = AutoEmulate()
ae.setup(X, y)
best_emulator = ae.compare()

# training set cross-validation results
# cross-validation results
ae.summarise_cv()
ae.plot_cv()

# test set results for the best model
# test set results for the best emulator
ae.evaluate(best_emulator)
ae.plot_eval(best_emulator)

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "autoemulate"
version = "0.2.0"
version = "0.2.2"
description = "A python package for semi-automated emulation"
license = "MIT"
authors = ["Martin Stoffel <[email protected]>",
Expand All @@ -11,6 +11,7 @@ authors = ["Martin Stoffel <[email protected]>",
"Eric Daub <[email protected]>",
"Steve Niederer <[email protected]>"]
readme = "README.md"
include = ["misc/AE_logo_final.png"]

[tool.poetry.dependencies]
python = ">=3.10,<3.13"
Expand Down

0 comments on commit 9fd28ff

Please sign in to comment.