Mod: Update version to 0.5.0 and documentation pages.

Labbeti · Dec 8, 2023 · a0dce3f · a0dce3f
1 parent a4c7f25
commit a0dce3f
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.5.0] UNRELEASED
+## [0.5.0] 2023-12-08
 ### Added
 - New `Vocab` metric to compute vocabulary size and vocabulary ratio.
 - New `BERTScoreMRefs` metric wrapper to compute BERTScore with multiple references.

diff --git a/CITATION.cff b/CITATION.cff
@@ -19,5 +19,5 @@ keywords:
   - captioning
   - audio-captioning
 license: MIT
-version: 0.4.6
-date-released: '2023-10-10'
+version: 0.5.0
+date-released: '2023-12-08'
diff --git a/README.md b/README.md
@@ -236,10 +236,10 @@ If you use this software, please consider cite it as "Labbe, E. (2013). aac-metr
     Labbe_aac_metrics_2023,
     author = {Labbé, Etienne},
     license = {MIT},
-    month = {10},
+    month = {12},
     title = {{aac-metrics}},
     url = {https://github.com/Labbeti/aac-metrics/},
-    version = {0.4.6},
+    version = {0.5.0},
     year = {2023},
 }
 ```

diff --git a/docs/aac_metrics.classes.bert_score_mrefs.rst b/docs/aac_metrics.classes.bert_score_mrefs.rst
@@ -0,0 +1,7 @@
+aac\_metrics.classes.bert\_score\_mrefs module
+==============================================
+
+.. automodule:: aac_metrics.classes.bert_score_mrefs
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_metrics.classes.fer.rst b/docs/aac_metrics.classes.fer.rst
@@ -0,0 +1,7 @@
+aac\_metrics.classes.fer module
+===============================
+
+.. automodule:: aac_metrics.classes.fer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_metrics.classes.vocab.rst b/docs/aac_metrics.classes.vocab.rst
@@ -0,0 +1,7 @@
+aac\_metrics.classes.vocab module
+=================================
+
+.. automodule:: aac_metrics.classes.vocab
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_metrics.functional.bert_score_mrefs.rst b/docs/aac_metrics.functional.bert_score_mrefs.rst
@@ -0,0 +1,7 @@
+aac\_metrics.functional.bert\_score\_mrefs module
+=================================================
+
+.. automodule:: aac_metrics.functional.bert_score_mrefs
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_metrics.classes.fluerr.rst → docs/aac_metrics.functional.fer.rst b/docs/aac_metrics.classes.fluerr.rst → docs/aac_metrics.functional.fer.rst
@@ -1,7 +1,7 @@
-aac\_metrics.classes.fluerr module
+aac\_metrics.functional.fer module
 ==================================
 
-.. automodule:: aac_metrics.classes.fluerr
+.. automodule:: aac_metrics.functional.fer
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/aac_metrics.functional.fluerr.rst b/docs/aac_metrics.functional.fluerr.rst
diff --git a/docs/aac_metrics.functional.vocab.rst b/docs/aac_metrics.functional.vocab.rst
@@ -0,0 +1,7 @@
+aac\_metrics.functional.vocab module
+====================================
+
+.. automodule:: aac_metrics.functional.vocab
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_metrics.utils.cmdline.rst b/docs/aac_metrics.utils.cmdline.rst
@@ -0,0 +1,7 @@
+aac\_metrics.utils.cmdline module
+=================================
+
+.. automodule:: aac_metrics.utils.cmdline
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/src/aac_metrics/__init__.py b/src/aac_metrics/__init__.py
@@ -10,7 +10,7 @@
 __maintainer__ = "Etienne Labbé (Labbeti)"
 __name__ = "aac-metrics"
 __status__ = "Development"
-__version__ = "0.4.6"
+__version__ = "0.5.0"
 
 
 from .classes.base import AACMetric