Welcome to Melusine’s documentation !

This package aims to be the reference in the processing and modelization of French email data. The project has been developed by MAIF.

Company	GitHub Account	Website
	MAIF GitHub	MAIF

Contents

• 1. Melusine
  • 1.1. Overview
  • 1.2. Release Notes
  • 1.3. The Melusine package
  • 1.4. Getting started : 30 seconds to Melusine
  • 1.5. Glossary
  • 1.6. Motivation & history
  • 1.7. Credits
• 2. Installation
  • 2.1. Stable release
  • 2.2. Optional dependencies
  • 2.3. From sources
• 3. Usage
  • 3.1. Melusine input data : Email DataFrames
  • 3.2. Prepare email subpackage : Basic usage
  • 3.3. Create an email pre-processing pipeline
  • 3.4. Create a custom email pre-processing function
  • 3.5. Testing a function on a single email
  • 3.6. NLP tools subpackage
  • 3.7. Summarizer subpackage
  • 3.8. Models subpackage
  • 3.9. Use a custom config file
  • 3.10. Use a custom name file
• 4. Package dependencies

API

• Melusine API
  • Utils subpackage melusine.utils
  • Prepare_email subpackage melusine.prepare_email
  • Nlp_tools subpackage melusine.nlp_tools
  • Summarizer subpackage melusine.summarizer
  • Models subpackage melusine.models
  • Config subpackage melusine.config
• Contributing
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
  • Tips
  • Deploying
• Credits
  • Development Lead (Quantmetry Team support Maif Team)
  • Contributors

Indices and tables

• Index

• Module Index

• Search Page