Bump version: 0.1.0 → 1.0.0

AstraZeneca · Jul 21, 2023 · 063278a · 063278a
1 parent b92f701
commit 063278a
Show file tree

Hide file tree

Showing 14 changed files with 45 additions and 30 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,50 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 <!-- towncrier release notes start -->
 
+## 1.0.0 - 2023-07-21
+
+
+### Features
+
+- Added support for SKOS-XL ontologies with SKOSXLGraphParser. 
+- Allowed running only some steps in a pipeline (including via API). See the Pipeline docs
+  (and the OpenAPI spec for the API details of new endpoints). 
+- Curations have been significantly overhauled and are now called CuratedTerms.
+  They now apply to single parsers, and offer a range of actions affecting linking and NER behaviour. Each CuratedTerm has a single CuratedTermBeheaviour, making them significantly simpler. 
+- Move MergeOverlappingEntsStep to after the AbbreviationFinderStep, which improves precision. 
+- Moved model training specific dependencies to an optional dependency group.
+  In particular, this is of value because the seqeval dependency doesn't distribute
+  a wheel, only an sdist in a legacy manner, which broke kazu installation in
+  environments requiring proxies. 
+- Switch off URI Stripping by default, and enable customizing the behaviour of URI stripping for Mapping ids.
+  See the docs for the StripMappingURIsAction class for details. 
+- The LabelStudio integration interface was improved and simplified. 
+- We now assign a MentionConfidence to each Entity based on the confidence of the NER hit.
+  This allows decoupling between specific NER steps and disambiguation strategies, which were previously intertwined.
+  This also applies to the CleanupStep which is decoupled from specific NER steps. 
+- We now use diskcache to give a simpler interface to elements of kazu that need to be 'built' in advance.
+  This particularly benefits the parsers, where it is now easy to use a new ParserDependentStep abstraction
+  to ensure appropriate parsers are loading, but to only load parsers once across all steps. 
+
+
+### Improved Documentation
+
+- We now generate docs for ``__call__`` methods. These are often significant in KAZU,
+  and we had the docstrings written in many cases, Sphinx just didn't show them
+  in the html. 
+
+
+### Deprecations and Removals
+
+- The ``ner`` and ``batch_ner`` API endpoints are deprecated and will be removed
+  in a future release. ``ner_and_linking`` should be used instead. This is because
+  we now have an ``ner_only`` endpoint, so the naming was liable to cause confusion.
+  It also simplifies the api, as a single endpoint can handle both a single document or
+  multiple. 
+- We deleted the 'modelling' element of the module structure, as this didn't add anything semantically, but led to longer imports.
+  This does mean any imports from these directories in your code will need to be rewritten - fortunately this is a simple 'find and delete' with 'modelling.' within your imports.
+
+
 ## 0.1.0 - 2023-03-29
 
 

diff --git a/docs/_changelog.d/+api_endpoint_dep.removal.rst b/docs/_changelog.d/+api_endpoint_dep.removal.rst
diff --git a/docs/_changelog.d/+call_docs.doc.rst b/docs/_changelog.d/+call_docs.doc.rst
diff --git a/docs/_changelog.d/+curationoverhaul.feature.rst b/docs/_changelog.d/+curationoverhaul.feature.rst
diff --git a/docs/_changelog.d/+diskcache.feature.rst b/docs/_changelog.d/+diskcache.feature.rst
diff --git a/docs/_changelog.d/+labelstudioimprovements.feature.rst b/docs/_changelog.d/+labelstudioimprovements.feature.rst
diff --git a/docs/_changelog.d/+mentionconfidence.feature.rst b/docs/_changelog.d/+mentionconfidence.feature.rst
diff --git a/docs/_changelog.d/+modellingfolderdeleted.removal.rst b/docs/_changelog.d/+modellingfolderdeleted.removal.rst
diff --git a/docs/_changelog.d/+optional_model_training_deps.feature.rst b/docs/_changelog.d/+optional_model_training_deps.feature.rst
diff --git a/docs/_changelog.d/+pipeline_flexibility.feature.rst b/docs/_changelog.d/+pipeline_flexibility.feature.rst
diff --git a/docs/_changelog.d/+pipelineorder.feature.rst b/docs/_changelog.d/+pipelineorder.feature.rst
diff --git a/docs/_changelog.d/+skosxl.feature.rst b/docs/_changelog.d/+skosxl.feature.rst
diff --git a/docs/_changelog.d/+uri_stripping.feature.rst b/docs/_changelog.d/+uri_stripping.feature.rst
diff --git a/kazu/__init__.py b/kazu/__init__.py
@@ -1 +1 @@
-__version__ = "0.1.0"
+__version__ = "1.0.0"