<p align="center">
<a href="https://github.com/MAIF/melusine/actions?branch=master" target="_blank">
<img src="https://github.com/MAIF/melusine/actions/workflows/main.yml/badge.svg?branch=master" alt="Build & Test">
</a>
<a href="https://pypi.python.org/pypi/melusine" target="_blank">
<img src="https://img.shields.io/pypi/v/melusine.svg" alt="pypi">
</a>
<a href="https://opensource.org/licenses/Apache-2.0" target="_blank">
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Test">
</a>
<a href="https://shields.io/" target="_blank">
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="pypi">
</a>
</p>
<p align="center">🎉 **BREAKING** : New major version <b>Melusine 3.0</b> is available 🎉</p>
<p align="center">
<a href="https://maif.github.io/melusine" target="_blank">
<img src="docs/_static/melusine.png">
</a>
</p>
- **Free software**: Apache Software License 2.0
- **Documentation**: [maif.github.io/melusine](https://maif.github.io/melusine/)
- **Installation**: `pip install melusine`
- **Tutorials**: [Discover melusine](https://maif.github.io/melusine/tutorials/00_GettingStarted/)
## Overview
Discover Melusine, a comprehensive email processing library
designed to optimize your email workflow.
Leverage Melusine's advanced features to achieve:
- **Effortless Email Routing**: Ensure emails reach their intended destinations with high accuracy.
- **Smart Prioritization**: Prioritize urgent emails for timely handling and efficient task management.
- **Snippet Summaries**: Extract relevant information from lengthy emails, saving you precious time and effort.
- **Precision Filtering**: Eliminate unwanted emails from your inbox, maintaining focus and reducing clutter.
Melusine facilitates the integration of deep learning frameworks (HuggingFace, Pytorch, Tensorflow, etc),
deterministic rules (regex, keywords, heuristics) into a full email qualification workflow.
## Why Choose Melusine ?
Melusine stands out with its combination of features and advantages:
- **Pre-packaged Tools** : Melusine comes with out-of-the-box features such as
- Segmenting an email conversation into individual messages
- Tagging message parts (Email body, signatures, footers, etc)
- Transferred email handling
- **Streamlined Execution** : Focus on the core email qualification logic
while Melusine handles the boilerplate code, providing debug mode, pipeline execution, code parallelization, and more.
- **Flexible Integrations** : Melusine's modular architecture enables seamless integration with various AI frameworks,
ensuring compatibility with your preferred tools.
- **Production ready** : Proven in the MAIF production environment,
Melusine provides the robustness and stability you need.
## Email Segmentation Exemple
In the following example, an email is divided into two distinct messages
separated by a transition pattern.
Each message is then tagged line by line.
This email segmentation can later be leveraged to enhance the performance of machine learning models.
<p align="center">
<a href="https://maif.github.io/melusine" target="_blank">
<img src="docs/_static/segmentation.png">
</a>
</p>
## Getting started
Explore our comprehensive [documentation](https://maif.github.io/melusine/) and tested [tutorials](https://maif.github.io/melusine/tutorials/00_GettingStarted/) to get started.
Or dive into our minimal example to experience Melusine's simplicity and power:
``` Python
from melusine.data import load_email_data
from melusine.pipeline import MelusinePipeline
# Load an email dataset
df = load_email_data()
# Load a pipeline
pipeline = MelusinePipeline.from_config("demo_pipeline")
# Run the pipeline
df = pipeline.transform(df)
```
The code above executes a default pipeline and returns a qualified email dataset with columns such as:
- `messages`: List of individual messages present in each email.
- `emergency_result`: Flag to identify urgent emails.
With Melusine, you're well-equipped to transform your email handling, streamlining processes, maximizing efficiency,
and enhancing overall productivity.
Raw data
{
"_id": null,
"home_page": "",
"name": "melusine",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "nlp,email,courriel,text,data-science,machine-learning,natural-language-processing",
"author": "Tiphaine Fabre, Sacha Samama, Antoine Simoulin",
"author_email": "Hugo Perrier <hugorperrier@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/aa/63/653a4023889f656297db1c071815229597ffd0a450695c4241886f61606b/melusine-3.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<a href=\"https://github.com/MAIF/melusine/actions?branch=master\" target=\"_blank\">\n<img src=\"https://github.com/MAIF/melusine/actions/workflows/main.yml/badge.svg?branch=master\" alt=\"Build & Test\">\n</a>\n<a href=\"https://pypi.python.org/pypi/melusine\" target=\"_blank\">\n<img src=\"https://img.shields.io/pypi/v/melusine.svg\" alt=\"pypi\">\n</a>\n<a href=\"https://opensource.org/licenses/Apache-2.0\" target=\"_blank\">\n<img src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\" alt=\"Test\">\n</a>\n<a href=\"https://shields.io/\" target=\"_blank\">\n<img src=\"https://img.shields.io/badge/python-3.8+-blue.svg\" alt=\"pypi\">\n</a>\n</p>\n\n<p align=\"center\">\ud83c\udf89 **BREAKING** : New major version <b>Melusine 3.0</b> is available \ud83c\udf89</p>\n\n<p align=\"center\">\n<a href=\"https://maif.github.io/melusine\" target=\"_blank\">\n<img src=\"docs/_static/melusine.png\">\n</a>\n</p>\n\n- **Free software**: Apache Software License 2.0\n- **Documentation**: [maif.github.io/melusine](https://maif.github.io/melusine/)\n- **Installation**: `pip install melusine`\n- **Tutorials**: [Discover melusine](https://maif.github.io/melusine/tutorials/00_GettingStarted/)\n\n## Overview\n\nDiscover Melusine, a comprehensive email processing library\ndesigned to optimize your email workflow.\nLeverage Melusine's advanced features to achieve:\n\n- **Effortless Email Routing**: Ensure emails reach their intended destinations with high accuracy.\n- **Smart Prioritization**: Prioritize urgent emails for timely handling and efficient task management.\n- **Snippet Summaries**: Extract relevant information from lengthy emails, saving you precious time and effort.\n- **Precision Filtering**: Eliminate unwanted emails from your inbox, maintaining focus and reducing clutter.\n\nMelusine facilitates the integration of deep learning frameworks (HuggingFace, Pytorch, Tensorflow, etc),\ndeterministic rules (regex, keywords, heuristics) into a full email qualification workflow.\n\n## Why Choose Melusine ?\n\nMelusine stands out with its combination of features and advantages:\n\n- **Pre-packaged Tools** : Melusine comes with out-of-the-box features such as\n - Segmenting an email conversation into individual messages\n - Tagging message parts (Email body, signatures, footers, etc)\n - Transferred email handling\n- **Streamlined Execution** : Focus on the core email qualification logic\nwhile Melusine handles the boilerplate code, providing debug mode, pipeline execution, code parallelization, and more.\n- **Flexible Integrations** : Melusine's modular architecture enables seamless integration with various AI frameworks,\nensuring compatibility with your preferred tools.\n- **Production ready** : Proven in the MAIF production environment,\nMelusine provides the robustness and stability you need.\n\n## Email Segmentation Exemple\n\nIn the following example, an email is divided into two distinct messages\nseparated by a transition pattern.\nEach message is then tagged line by line.\nThis email segmentation can later be leveraged to enhance the performance of machine learning models.\n\n<p align=\"center\">\n<a href=\"https://maif.github.io/melusine\" target=\"_blank\">\n<img src=\"docs/_static/segmentation.png\">\n</a>\n</p>\n\n## Getting started\n\nExplore our comprehensive [documentation](https://maif.github.io/melusine/) and tested [tutorials](https://maif.github.io/melusine/tutorials/00_GettingStarted/) to get started.\nOr dive into our minimal example to experience Melusine's simplicity and power:\n\n``` Python\n from melusine.data import load_email_data\n from melusine.pipeline import MelusinePipeline\n\n # Load an email dataset\n df = load_email_data()\n\n # Load a pipeline\n pipeline = MelusinePipeline.from_config(\"demo_pipeline\")\n\n # Run the pipeline\n df = pipeline.transform(df)\n```\n\nThe code above executes a default pipeline and returns a qualified email dataset with columns such as:\n- `messages`: List of individual messages present in each email.\n- `emergency_result`: Flag to identify urgent emails.\n\n\nWith Melusine, you're well-equipped to transform your email handling, streamlining processes, maximizing efficiency,\nand enhancing overall productivity.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Melusine is a high-level library for emails processing",
"version": "3.0.0",
"project_urls": null,
"split_keywords": [
"nlp",
"email",
"courriel",
"text",
"data-science",
"machine-learning",
"natural-language-processing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e424067731f1c0b36c1f81dbf79c15fa6787dd68cf7dd5c1c68319f8afbbabcd",
"md5": "d2169a9cf6212bec2ceb08c50c55343c",
"sha256": "075551e361b9b7015f9542d9866dc74dc977d3e26e65b6ef7ef8b965e2aa8963"
},
"downloads": -1,
"filename": "melusine-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2169a9cf6212bec2ceb08c50c55343c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 293738,
"upload_time": "2024-01-15T17:22:00",
"upload_time_iso_8601": "2024-01-15T17:22:00.935636Z",
"url": "https://files.pythonhosted.org/packages/e4/24/067731f1c0b36c1f81dbf79c15fa6787dd68cf7dd5c1c68319f8afbbabcd/melusine-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aa63653a4023889f656297db1c071815229597ffd0a450695c4241886f61606b",
"md5": "9215e8fddfabd4e8d27b5ad816924f7b",
"sha256": "e078a8a1c606b5a9d919cbb87d61da32c9798f391b9ba8f389b0a7be1f598d33"
},
"downloads": -1,
"filename": "melusine-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9215e8fddfabd4e8d27b5ad816924f7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 267619,
"upload_time": "2024-01-15T17:22:03",
"upload_time_iso_8601": "2024-01-15T17:22:03.438634Z",
"url": "https://files.pythonhosted.org/packages/aa/63/653a4023889f656297db1c071815229597ffd0a450695c4241886f61606b/melusine-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 17:22:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "melusine"
}
JSON