Merge pull request #2 from GPla/change/1/fix-example

fix example in readme and doc

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 <https://github.com/GPla/faster-eTaPR/issues/1>`__
+
 
 0.1.0 (2024-03-26)
 ------------------

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,

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} <https://github.com/saurf4ng/eTaPR/issues/{issue}>`__"
+    issue_format = "`#{issue} <https://github.com/GPla/faster-eTaPR/issues/{issue}>`__"
     title_format = "{version} ({project_date})"
     underlines=["-", "-", "^"]
 

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.'

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,