diff --git a/docs/releases.md b/docs/releases.md index 3caf4b889c7f3d81fec9fd78539ed25dd61ea539..175fac96358837ac4f649a4eae4ee9d179b7f0f0 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -1,5 +1,40 @@ # Releases +## 0.3.2 + +Released on **8 March 2023** • View on [Gitlab](https://gitlab.com/teklia/workers/base-worker/-/releases/0.3.2) + + +- A helper to use the new [API endpoint](https://demo.arkindex.org/api-docs/#tag/entities/operation/CreateTranscriptionEntities) to create transcription entities more efficiently was implemented. +- Training workers may now publish a model configuration when creating a new model version on Arkindex. This will make the execution of a *generic* worker much smoother. +- The model version API endpoints were updated in the [latest Arkindex release](https://teklia.com/solutions/arkindex/releases/1-4-0/) and a new helper was introduced subsequently. However, there are no breaking changes and the main helper, `publish_model_version`, still has the same signature and behaviour. +- The latest Arkindex release changed the way NER entities are stored and published. + - The `EntityType` enum was removed as type slug are no longer restrcited to a small options, + - [create_entity](https://workers.arkindex.org/ref/api/entity/#arkindex_worker.worker.entity.EntityMixin.create_entity) now expects a type slug as a String, + - a new helper [list_corpus_entity_types](https://workers.arkindex.org/ref/api/entity/#arkindex_worker.worker.entity.EntityMixin.list_corpus_entity_types) was added to load the Entity types in the corpus, + - a new helper [check_required_entity_types](https://workers.arkindex.org/ref/api/entity/#arkindex_worker.worker.entity.EntityMixin.check_required_entity_types) to make sure that needed entity types are available in the corpus was added. Missing ones are created by default (this can be disabled). +- The [create_classifications](https://workers.arkindex.org/ref/api/classification/#arkindex_worker.worker.classification.ClassificationMixin.create_classifications) helper now expects the UUID of each MLClass instead of their name. +- In developer mode, the only way to set the `corpus_id` attribute is to use the `ARKINDEX_CORPUS_ID` environment variable. When it's not set, all API requests using the `corpus_id` as path parameter will fail with `500` status code. A warning log was added to help developers troubleshoot this error by advising them to set this variable. +- The [create_transcriptions](https://workers.arkindex.org/ref/api/transcription/#arkindex_worker.worker.transcription.TranscriptionMixin.create_transcriptions) helper no longer makes the API call in developer mode. This behaviour aligns with all other publication helpers. +- Fixes hash computation when publishing a model using [publish_model_version](https://workers.arkindex.org/ref/api/training/#arkindex_worker.worker.training.TrainingMixin.publish_model_version). +- If a process is linked to a model version, its id will be available to the worker through its `model_version_id` attribute. +- The URLs of the API endpoint related to Ponos were changed in the latest Arkindex release. Some changes were needed in the test suite. +- The `classes` attribute no directly contains the classes of the corpus of the processed element. +```python +# Old usage +self.classes = { + "corpus_id": { + "ml_class_1": "class_uuid", + ... + } +} + +# New usage +self.classes = { + "ml_class_1": "class_uuid", + ... +} +``` ## 0.3.1