Skip to content

Commit

Permalink
📝 Readme for melusine 3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoPerrier committed Dec 18, 2023
1 parent da28258 commit 250bb09
Showing 1 changed file with 31 additions and 17 deletions.
48 changes: 31 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,40 @@
[![pypi badge](https://img.shields.io/pypi/v/melusine.svg)](https://pypi.python.org/pypi/melusine)
[![Build & Test](https://github.com/MAIF/melusine/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/MAIF/melusine/actions/workflows/main.yml)[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Generic badge](https://img.shields.io/badge/python-3.8+-blue.svg)](https://shields.io/)

🎉 BREAKING : New major version **Melusine 3.0.0** is available 🎉
Checkout the [documentation](https://maif.github.io/melusine/) and [tutorials](https://maif.github.io/melusine/tutorials/00_GettingStarted/) to get started.

<!-- <img src=`docs/_static/melusine.png` width=`200`/> -->
![](docs/_static/melusine.png)

- Free software: Apache Software License 2.0
- Documentation: [click here](https://maif.github.io/melusine/).
- Installation: `pip install melusine`.
<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 **Melusine 3.0.0** 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


Melusine is a high-level library for emails processing that can be used to do:

- Email routing: Make sure emails are sent to the most appropriate destination.
- Prioritization: Ensure urgent emails are treated first.
- Summarization: Save time reading summaries instead of long emails.
- Filtering: Remove undesired emails.
- **Email routing**: Make sure emails are sent to the most appropriate destination.
- **Prioritization**: Ensure urgent emails are treated first.
- **Summarization**: Save time reading summaries instead of long emails.
- **Filtering**: Remove undesired emails.

Melusine facilitates the integration of deep learning frameworks (HuggingFace, Pytorch, Tensorflow, etc)
deterministic rules (regex, keywords, heuristics) into a full email qualification workflow.
Expand Down

0 comments on commit 250bb09

Please sign in to comment.