Marie-ai

> Release time: 2024-03-04 11:21:11



🙇 We'd like to thank all contributors for this new release! In particular,
Marie Dev Bot, Greg Bugaj, Rithsek Ngem, 🙇


🆕 New Features

- [[97bb7793](https://github.com/marieai/marie-ai/commit/97bb779307b2191b6269f3f5ac29d7a4c196f319)] __-__ add validation to Document Indexer (*Marie Dev Bot*)
- [[55b47796](https://github.com/marieai/marie-ai/commit/55b47796dfe7c7355b6ce10c1ff8a17ba63beccc)] __-__ fix streamlit security issue (*Marie Dev Bot*)
- [[ef0c8e80](https://github.com/marieai/marie-ai/commit/ef0c8e80a25c1b49d3ddec2c96f06469db2920dd)] __-__ add support for multiline entity grouping (*Marie Dev Bot*)
- [[5f1abfe8](https://github.com/marieai/marie-ai/commit/5f1abfe87969d537ab8838e129a0746933644b98)] __-__ Refactor document intexers and classifiers (*Marie Dev Bot*)
- [[57ec0cfd](https://github.com/marieai/marie-ai/commit/57ec0cfd9c5e7891f3b18757c6391dc54b790989)] __-__ refactoring Document Indexer (*Marie Dev Bot*)
- [[2caadcb7](https://github.com/marieai/marie-ai/commit/2caadcb7d28dcb1bf98078b426c91dc38db78d90)] __-__ Add new voting strategy feature (*Marie Dev Bot*)

🐞 Bug fixes

- [[71a57d62](https://github.com/marieai/marie-ai/commit/71a57d62bac71cae83f2cec64547addebf42a159)] __-__ add support for extracting version numbers (*Marie Dev Bot*)
- [[227cabbb](https://github.com/marieai/marie-ai/commit/227cabbb24ad0a4b73f98d43442189fc708b9068)] __-__ updated to be compatible withi dataframes 2 (*Marie Dev Bot*)
- [[cbdd39d8](https://github.com/marieai/marie-ai/commit/cbdd39d805177d2a1de33470120e7d40eac7b4c3)] __-__ Fixed issue with normalized bounding boxes in document indexer (*Marie Dev Bot*)

🧼 Code Refactoring

- [[732471a6](https://github.com/marieai/marie-ai/commit/732471a6b0a4d6140be964a66a1e2b62edbdee77)] __-__ "batch ner ocr&34; (*Rithsek Ngem*)

🍹 Other Improvements

- [[760f39be](https://github.com/marieai/marie-ai/commit/760f39befe155ca6c7373236b89a7c6a88340451)] __-__ remove stale files (*Greg Bugaj*)
- [[8464e33f](https://github.com/marieai/marie-ai/commit/8464e33f224e61bc693e7add54dbd190a1881922)] __-__ version bump (*Greg Bugaj*)
- [[687626c3](https://github.com/marieai/marie-ai/commit/687626c3ed39fe44b2daf3d082ae24fe0da2dec6)] __-__ cleanup (*Marie Dev Bot*)
- [[eb105423](https://github.com/marieai/marie-ai/commit/eb105423efef1355e23b562e2405a62501369f24)] __-__ template matching (*Marie Dev Bot*)
- [[036892c6](https://github.com/marieai/marie-ai/commit/036892c63d4098750088b03a3fcb0dd70bcc2d5c)] __-__ changed schema for entity (*Marie Dev Bot*)
- [[4dd42f07](https://github.com/marieai/marie-ai/commit/4dd42f070c8c1e742886e0487045553a6bd09e6c)] __-__ wip (*Marie Dev Bot*)
- [[de76c7a4](https://github.com/marieai/marie-ai/commit/de76c7a427be9f04d9d14743a9c6989e2b392654)] __-__ cleanup of invalid configs (*Marie Dev Bot*)
- [[8462c5f8](https://github.com/marieai/marie-ai/commit/8462c5f84d28a75516b93c4ef7d90cd9a71b3f64)] __-__ classifier voting (*Marie Dev Bot*)
- [[02e23605](https://github.com/marieai/marie-ai/commit/02e236057f4b182417c356cb58911bfc7fda6386)] __-__ document indexing (*Marie Dev Bot*)
- [[3115eb7d](https://github.com/marieai/marie-ai/commit/3115eb7dd0b97990ee2251b1941e9165e389bc39)] __-__ __version__: the next version will be 3.0.29 (*Marie Dev Bot*)



Release & Version Identifier

Marie is shipped from two package management systems, PyPi and Docker Hub. This article clarifies the release cycle and version identifier behind each system.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [PyPi package versioning](pypi-package-versioning)
- [Docker image versioning](docker-image-versioning)
- [Manual Release Entrypoint](manual-release-entrypoint)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->


PyPi package versioning

We follow [PEP-440](https://www.python.org/dev/peps/pep-0440/), and a form of [semantic versioning](https://semver.org/) as explained above.

To install the latest final release:

bash
pip install -U marie-ai


To install a particular final release:

bash
pip install marie-ai==x.y.z


The term "final release" is relative to "developmental release" as described below.

Install Marie with Recommended Extensions

`pip install -U marie-ai` only installs the core dependencies of Marie.

The recommended way of installing Marie is `pip install -U marie-ai`

`"standard"` include extra dependencies that enables:
- Executor Hub + Docker support
- FastAPI + Websocket support (required when using `Flow(protocol='http')` or `Flow(protocol='websocket')`)
- the best compression via LZ4 algorithm
- the best async eventloop management via `uvloop`

Other extension tags such as `[devel]` can be found in [extra-requirements.txt](extra-requirements.txt).

Do I need "[standard]"?

Depends on how you use and distribute Marie.

If you are using/distributing Marie as a microservice, you often only need to install the core dependencies via `pip install marie-ai`.

Developmental releases versioning

One every master-merging event, we create early releases directly from source control which do not conflict with later project releases. The version identifier for development release is `x.y.z.devN`, which adds a suffix `.dev`, followed by a non-negative integer value `N`, which is reset on every release.

To install the latest development release:

bash
pip install --pre marie


Version epochs


Release cycle and versioning
Marie is developed continuously by the community and core team. Updates are grouped and released at regular intervals to align with software development best practices.

Marie follows a form of numbered versioning. The version number of the product is a three-part value `x.y.z` where `x`, `y`, and `z` are the major, minor, and patch components respectively.

- Patch release (`x.y.z` -> `x.y.(z+1)`): Contain bug fixes, new features and breaking changes. Released weekly on a Wednesday morning CET.
- Minor release (`x.y.z -> x.(y+1).0`): Contain bug fixes, new features and breaking changes. Released monthly on the first Wednesday of the month CET. This release is more QA tested and considered more stable than a patch release.
- Major release (`x.y.z -> (x+1).0.0`): Are released based on the development cycle of the Marie . There is no set scheduled for when these will occur.


The following example shows how Marie is released from 0.9 to 0.9.2 according to the schema we defined above.

|Event `e` | After `e`, `pip install marie-ai` | After `e`, `pip install --pre marie-ai` | After `e`, master `__init__.py` |
|--- |-----------------------------------| --- | --- |

> Release time: 2024-02-15 06:48:56



🙇 We'd like to thank all contributors for this new release! In particular,
Marie Dev Bot, Rithsek Ngem, 🙇


🆕 New Features

- [[6c943478](https://github.com/marieai/marie-ai/commit/6c943478243f3267dea0e3813fda9a67d98bbcd5)] __-__ add support for grouping classifiers (*Marie Dev Bot*)
- [[7243d8ba](https://github.com/marieai/marie-ai/commit/7243d8bad38dc3b3e1456677f541fb3f43ddffb8)] __-__ Document classification and document indexing(named entity recognition) have been reworked (*Marie Dev Bot*)
- [[3cb13758](https://github.com/marieai/marie-ai/commit/3cb137584e28fea62d6e23f54d243f226a38563c)] __-__ refactored how document filters work (*Marie Dev Bot*)
- [[44de5961](https://github.com/marieai/marie-ai/commit/44de596196ced524c8a0324e2b8e934b59266c9a)] __-__ integration cleanup (*Marie Dev Bot*)
- [[7d9c781c](https://github.com/marieai/marie-ai/commit/7d9c781c7c221e2f3b924774c86d4f42e8719a2a)] __-__ add support for pgvector (*Marie Dev Bot*)
- [[7b8cfe83](https://github.com/marieai/marie-ai/commit/7b8cfe83aaa7b0583839db9ed613227939f3f15b)] __-__ Initial work on document embeddings (*Marie Dev Bot*)
- [[d763abbb](https://github.com/marieai/marie-ai/commit/d763abbb7bb333749fee84a0e3ff07aa9e1509e5)] __-__ upgrade to docosaurus 3.1.1 (*Marie Dev Bot*)

🐞 Bug fixes

- [[a9dcc088](https://github.com/marieai/marie-ai/commit/a9dcc0885d03ec6a4bba38c3e7a2aed99358a6fc)] __-__ Issue with Overload resolution; closes #104 (*Rithsek Ngem*)
- [[0a8ee56b](https://github.com/marieai/marie-ai/commit/0a8ee56b818ba70512a0295731ab240b7edd5a2b)] __-__ fixed issues with missing directory (*Marie Dev Bot*)

🍹 Other Improvements

- [[9adf3da4](https://github.com/marieai/marie-ai/commit/9adf3da453f9508c9b67b4b80776c22a8eb61e30)] __-__ updated executors to use multiple pipleline configs (*Marie Dev Bot*)
- [[ec2cf4bb](https://github.com/marieai/marie-ai/commit/ec2cf4bb8a4c964d2cf0612a0ecc8cdbad8173e0)] __-__ refactoring Named Entity Extractor (*Marie Dev Bot*)
- [[d47f865c](https://github.com/marieai/marie-ai/commit/d47f865c53e448b043178cf0cf8cae7856d02049)] __-__ classification (*Marie Dev Bot*)
- [[93548b72](https://github.com/marieai/marie-ai/commit/93548b7248daaabf1013553156462de5bf58bf88)] __-__ add error handling (*Marie Dev Bot*)
- [[d6a73fe7](https://github.com/marieai/marie-ai/commit/d6a73fe7541f36bc33fa53dd614d84729451a433)] __-__ add missing docker files (*Marie Dev Bot*)
- [[e7ff659e](https://github.com/marieai/marie-ai/commit/e7ff659ecdca9b276e07560dc1b8d01c8bbc477b)] __-__ pgvector (*Marie Dev Bot*)
- [[af840412](https://github.com/marieai/marie-ai/commit/af840412c668f5f5b02c8c6bdc3b87fbe4756ea1)] __-__ fix : Issue with array brodcasting; closes #106 (*Marie Dev Bot*)
- [[3ea21f7f](https://github.com/marieai/marie-ai/commit/3ea21f7fdaf41fdf0416af1337525b2c988f53c7)] __-__ add notes (*Marie Dev Bot*)
- [[1d7de69f](https://github.com/marieai/marie-ai/commit/1d7de69ff27768249a3ee2698b421993301e8577)] __-__ __docs__: Updated docosaurus to 3.1.1 (*Marie Dev Bot*)
- [[1b5c2736](https://github.com/marieai/marie-ai/commit/1b5c2736a7609e132e29a1cf3fffed440021bc8b)] __-__ __version__: the next version will be 3.0.28 (*Marie Dev Bot*)
- [[b03ffef8](https://github.com/marieai/marie-ai/commit/b03ffef8456cf4064b3134048de9c42a5b2fe6ab)] __-__ testing bouding box processing (*Marie Dev Bot*)

<a name=release-note-3-0-29></a>

> Release time: 2024-01-29 05:30:16

<a name=release-note-3-0-28></a>

> Release time: 2023-11-28 12:52:36



🙇 We'd like to thank all contributors for this new release! In particular,
Marie Dev Bot, Greg, Greg Bugaj, 🙇


~~ 🆕 New Features

- [[6a75565a](https://github.com/marieai/marie-ai/commit/6a75565aede2eb2d403b7e37f4e3b3a4283073f7)] __-__ add proper torch caching changed Torch autocast inference to be only used for CPU changed how executors determine their device types (*Marie Dev Bot*)
- [[16a1306d](https://github.com/marieai/marie-ai/commit/16a1306d1e976da54c63dc5de4b3f33471abdfc1)] __-__ merging jina v3.23.0 (*Greg*)

🐞 Bug fixes

- [[d5d82827](https://github.com/marieai/marie-ai/commit/d5d828272bafc62dc7f2aecbdb42e7735447f1cb)] __-__ added tesseract to the configs (*Greg Bugaj*)
- [[1980e43c](https://github.com/marieai/marie-ai/commit/1980e43ce802e0ec22358dc9ddf8b3f525aa85fc)] __-__ work on fixing caching of BERT models (*Greg*)

🍹 Other Improvements

- [[5c7a7123](https://github.com/marieai/marie-ai/commit/5c7a71236f040db860a182545459e726893d44cf)] __-__ __fix__: version fix before release (*Marie Dev Bot*)
- [[542dcfc0](https://github.com/marieai/marie-ai/commit/542dcfc0f0d04e941abf332cb27f227f98c0163f)] __-__ Update force-release.yml (*Greg*)
- [[1ddb8004](https://github.com/marieai/marie-ai/commit/1ddb800486cac546577113fd56f95db357192a87)] __-__ working on decoupling OCR engines (*Marie Dev Bot*)~~

<a name=release-note-3-0-26></a>

> Release time: 2023-11-28 12:49:01



🙇 We'd like to thank all contributors for this new release! In particular,
Marie Dev Bot, Greg, Greg Bugaj, 🙇


🆕 New Features

- [[6a75565a](https://github.com/marieai/marie-ai/commit/6a75565aede2eb2d403b7e37f4e3b3a4283073f7)] __-__ add proper torch caching changed Torch autocast inference to be only used for CPU changed how executors determine their device types (*Marie Dev Bot*)
- [[16a1306d](https://github.com/marieai/marie-ai/commit/16a1306d1e976da54c63dc5de4b3f33471abdfc1)] __-__ merging jina v3.23.0 (*Greg*)

🐞 Bug fixes

- [[d5d82827](https://github.com/marieai/marie-ai/commit/d5d828272bafc62dc7f2aecbdb42e7735447f1cb)] __-__ added tesseract to the configs (*Greg Bugaj*)
- [[1980e43c](https://github.com/marieai/marie-ai/commit/1980e43ce802e0ec22358dc9ddf8b3f525aa85fc)] __-__ work on fixing caching of BERT models (*Greg*)

🍹 Other Improvements

- [[0a96f933](https://github.com/marieai/marie-ai/commit/0a96f9337b55a751be782f903f07769160f934b9)] __-__ __fix__: version fix before release (*Marie Dev Bot*)
- [[542dcfc0](https://github.com/marieai/marie-ai/commit/542dcfc0f0d04e941abf332cb27f227f98c0163f)] __-__ Update force-release.yml (*Greg*)
- [[1ddb8004](https://github.com/marieai/marie-ai/commit/1ddb800486cac546577113fd56f95db357192a87)] __-__ working on decoupling OCR engines (*Marie Dev Bot*)

<a name=release-note-3-0-24></a>

> Release time: 2023-11-01 15:03:52



🙇 We'd like to thank all contributors for this new release! In particular,
Marie Dev Bot, 🙇


🍹 Other Improvements

- [[368fbfb4](https://github.com/marieai/marie-ai/commit/368fbfb46912418d88df33a1ec7039b864cec391)] __-__ __release__: release v3.0.21 (*Marie Dev Bot*)

<a name=release-note-3-0-23></a>