diff --git a/CHANGELOG.rst b/CHANGELOG.rst index dab577e..4ce5b47 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -12,6 +12,18 @@ Changes for the upcoming release can be found in the "changelog" directory in ou .. towncrier release notes start +0.1.2 (2024-04-08) +------------------ + + + + +Changes +^^^^^^^ + +- Fix example in readme and docstring. + `#1 `__ + 0.1.0 (2024-03-26) ------------------ diff --git a/README.rst b/README.rst index 45a651d..38e856c 100644 --- a/README.rst +++ b/README.rst @@ -69,7 +69,7 @@ Now, you run your evaluation in python: .. code:: import faster_etapr - faster_etapr.evaluate_from_ranges( + faster_etapr.evaluate_from_preds( y_hat=[0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 1, 1, 0, 0, 0], y= [0, 1, 1, 0, 0, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 0, 1], theta_p=0.5, diff --git a/pyproject.toml b/pyproject.toml index 2b09bf9..e2c9776 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -71,6 +71,7 @@ dev-dependencies = [ "tox>=4.14.2", "uv>=0.1.24", "pytest-cov>=5.0.0", + "towncrier>=23.11.0", ] [tool.hatch.metadata] @@ -104,11 +105,11 @@ force-single-line = true [tool.towncrier] package_dir="src" - package = "etapr" + package = "faster_etapr" filename = "CHANGELOG.rst" directory = "changelog" template = "changelog/towncrier_template.rst" - issue_format = "`#{issue} `__" + issue_format = "`#{issue} `__" title_format = "{version} ({project_date})" underlines=["-", "-", "^"] diff --git a/src/faster_etapr/__init__.py b/src/faster_etapr/__init__.py index 9a7414a..720c234 100644 --- a/src/faster_etapr/__init__.py +++ b/src/faster_etapr/__init__.py @@ -1,4 +1,4 @@ -__version__ = '0.1.1' +__version__ = '0.1.2' __title__ = 'faster-eTaPR' __description__ = 'Faster implementation of github.com/saurf4ng/eTaPR.' diff --git a/src/faster_etapr/etapr.py b/src/faster_etapr/etapr.py index 37e8783..070950c 100644 --- a/src/faster_etapr/etapr.py +++ b/src/faster_etapr/etapr.py @@ -699,7 +699,7 @@ def evaluate_from_preds( Example: >>> import faster_etapr - >>> faster_etapr.evaluate_from_ranges( + >>> faster_etapr.evaluate_from_preds( ... y_hat=[0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 1, 1, 0, 0, 0], ... y= [0, 1, 1, 0, 0, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 0, 1], ... theta_p=0.5,