[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md) [![CLA](https://img.shields.io/badge/CLA%3F-Required-blue.svg)](https://mycroft.ai/cla) [![Team](https://img.shields.io/badge/Team-Mycroft_Core-violetblue.svg)](https://github.com/MycroftAI/contributors/blob/master/team/Mycroft%20Core.md) ![Status](https://img.shields.io/badge/-Production_ready-green.svg)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![Join chat](https://img.shields.io/badge/Mattermost-join_chat-brightgreen.svg)](https://chat.mycroft.ai/community/channels/machine-learning)
# Padatious
An efficient and agile neural network intent parser. Padatious is a core component of [Mycroft AI](https://mycroft.ai).
## Features
- Intents are easy to create
- Requires a relatively small amount of data
- Intents run independent of each other
- Easily extract entities (ie. Find the nearest *gas station* -> `place: gas station`)
- Fast training with a modular approach to neural networks
## Getting Started
### Installing
Padatious requires the following native packages to be installed:
- [`FANN`][fann] (with dev headers)
- Python development headers
- `pip3`
- `swig`
Ubuntu:
```
sudo apt-get install libfann-dev python3-dev python3-pip swig libfann-dev python3-fann2
```
Next, install Padatious via `pip3`:
```
pip3 install padatious
```
Padatious also works in Python 2 if you are unable to upgrade.
[fann]:https://github.com/libfann/fann
### Example
Here's a simple example of how to use Padatious:
#### program.py
```Python
from padatious import IntentContainer
container = IntentContainer('intent_cache')
container.add_intent('hello', ['Hi there!', 'Hello.'])
container.add_intent('goodbye', ['See you!', 'Goodbye!'])
container.add_intent('search', ['Search for {query} (using|on) {engine}.'])
container.train()
print(container.calc_intent('Hello there!'))
print(container.calc_intent('Search for cats on CatTube.'))
container.remove_intent('goodbye')
```
Run with:
```bash
python3 program.py
```
## Learn More
Further documentation can be found at https://mycroft.ai/documentation/padatious/
Raw data
{
"_id": null,
"home_page": "http://github.com/MycroftPhoenix/padatious_phoenix",
"name": "padatious-phoenix",
"maintainer": "Steve Chr\u00e9tien",
"docs_url": null,
"requires_python": null,
"maintainer_email": "stevechretien111@protonmail.com",
"keywords": "intent-parser parser text text-processing",
"author": "Matthew Scholefield",
"author_email": "matthew331199@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d6/f0/bd828a01a32368f4f4230f8b787fd21b9a92d5371dded95a8b4d43ac8c6f/padatious_phoenix-0.4.9.tar.gz",
"platform": null,
"description": "[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md) [![CLA](https://img.shields.io/badge/CLA%3F-Required-blue.svg)](https://mycroft.ai/cla) [![Team](https://img.shields.io/badge/Team-Mycroft_Core-violetblue.svg)](https://github.com/MycroftAI/contributors/blob/master/team/Mycroft%20Core.md) ![Status](https://img.shields.io/badge/-Production_ready-green.svg)\n\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)\n[![Join chat](https://img.shields.io/badge/Mattermost-join_chat-brightgreen.svg)](https://chat.mycroft.ai/community/channels/machine-learning)\n\n# Padatious\n\nAn efficient and agile neural network intent parser. Padatious is a core component of [Mycroft AI](https://mycroft.ai). \n\n## Features\n\n - Intents are easy to create\n - Requires a relatively small amount of data\n - Intents run independent of each other\n - Easily extract entities (ie. Find the nearest *gas station* -> `place: gas station`)\n - Fast training with a modular approach to neural networks\n\n## Getting Started\n\n### Installing\n\nPadatious requires the following native packages to be installed:\n\n - [`FANN`][fann] (with dev headers)\n - Python development headers\n - `pip3`\n - `swig`\n\nUbuntu:\n\n```\nsudo apt-get install libfann-dev python3-dev python3-pip swig libfann-dev python3-fann2\n```\n\nNext, install Padatious via `pip3`:\n\n```\npip3 install padatious\n```\nPadatious also works in Python 2 if you are unable to upgrade.\n\n\n[fann]:https://github.com/libfann/fann\n\n### Example\n\nHere's a simple example of how to use Padatious:\n\n#### program.py\n```Python\nfrom padatious import IntentContainer\n\ncontainer = IntentContainer('intent_cache')\ncontainer.add_intent('hello', ['Hi there!', 'Hello.'])\ncontainer.add_intent('goodbye', ['See you!', 'Goodbye!'])\ncontainer.add_intent('search', ['Search for {query} (using|on) {engine}.'])\ncontainer.train()\n\nprint(container.calc_intent('Hello there!'))\nprint(container.calc_intent('Search for cats on CatTube.'))\n\ncontainer.remove_intent('goodbye')\n```\n\nRun with:\n\n```bash\npython3 program.py\n```\n\n## Learn More\n\nFurther documentation can be found at https://mycroft.ai/documentation/padatious/\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A neural network intent parser",
"version": "0.4.9",
"project_urls": {
"Homepage": "http://github.com/MycroftPhoenix/padatious_phoenix"
},
"split_keywords": [
"intent-parser",
"parser",
"text",
"text-processing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8bb654ee1a04220e5011413321662e3e14f901cfa798daf4b5ef94904015cdd4",
"md5": "49ca0cf728e0718946c2f07fe309f5bf",
"sha256": "915d010c4f4ba5e5b755744d6512f931c10a64ef7e7240fc4c73b9244c2c6d22"
},
"downloads": -1,
"filename": "padatious_phoenix-0.4.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "49ca0cf728e0718946c2f07fe309f5bf",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 28418,
"upload_time": "2024-05-07T00:49:42",
"upload_time_iso_8601": "2024-05-07T00:49:42.518891Z",
"url": "https://files.pythonhosted.org/packages/8b/b6/54ee1a04220e5011413321662e3e14f901cfa798daf4b5ef94904015cdd4/padatious_phoenix-0.4.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d6f0bd828a01a32368f4f4230f8b787fd21b9a92d5371dded95a8b4d43ac8c6f",
"md5": "d545b55c60de6fbfb3cc40db5885072b",
"sha256": "ced92156179b6278c68f84668c608f24785c55c3dc456d044d4f65d3e06c849f"
},
"downloads": -1,
"filename": "padatious_phoenix-0.4.9.tar.gz",
"has_sig": false,
"md5_digest": "d545b55c60de6fbfb3cc40db5885072b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24340,
"upload_time": "2024-05-07T00:49:44",
"upload_time_iso_8601": "2024-05-07T00:49:44.628250Z",
"url": "https://files.pythonhosted.org/packages/d6/f0/bd828a01a32368f4f4230f8b787fd21b9a92d5371dded95a8b4d43ac8c6f/padatious_phoenix-0.4.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-07 00:49:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MycroftPhoenix",
"github_project": "padatious_phoenix",
"github_not_found": true,
"lcname": "padatious-phoenix"
}