Skip to content

Commit 9fd28ff

Browse files
committed
fix README
1 parent a8828d5 commit 9fd28ff

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AutoEmulate <a href="https://alan-turing-institute.github.io/autoemulate/"><img src="misc/AE_logo_final.png" align="right" height="138" /></a>
1+
# 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>
22

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

22-
There's also a release onPyPI:
22+
There's also a release on PyPI:
2323

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

49-
# compare emulator models
49+
# compare emulators
5050
ae = AutoEmulate()
5151
ae.setup(X, y)
5252
best_emulator = ae.compare()
5353

54-
# training set cross-validation results
54+
# cross-validation results
5555
ae.summarise_cv()
5656
ae.plot_cv()
5757

58-
# test set results for the best model
58+
# test set results for the best emulator
5959
ae.evaluate(best_emulator)
6060
ae.plot_eval(best_emulator)
6161

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "autoemulate"
3-
version = "0.2.0"
3+
version = "0.2.2"
44
description = "A python package for semi-automated emulation"
55
license = "MIT"
66
authors = ["Martin Stoffel <[email protected]>",
@@ -11,6 +11,7 @@ authors = ["Martin Stoffel <[email protected]>",
1111
"Eric Daub <[email protected]>",
1212
"Steve Niederer <[email protected]>"]
1313
readme = "README.md"
14+
include = ["misc/AE_logo_final.png"]
1415

1516
[tool.poetry.dependencies]
1617
python = ">=3.10,<3.13"

0 commit comments

Comments
 (0)