| Name | maihem JSON |
| Version |
1.4.2
JSON |
| download |
| home_page | None |
| Summary | LLM evaluations and synthetic data generation with the MAIHEM models |
| upload_time | 2024-04-16 07:49:41 |
| maintainer | None |
| docs_url | None |
| author | MAIHEM |
| requires_python | >=3.5 |
| license | MIT License Copyright (c) 2023 MAIHEM Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
genai
llm
evaluation
data
generation
synthetic
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# maihem
## Introduction
The **maihem** python package allows you to simulate personas and generate synthetic text data for training and evaluating your LLMs. It also provides text data evaluations.
## Getting Started
### Installation
To install the API, run the following command:
```
pip install maihem
```
### Obtaining your maihem API key
Request a free API key here: [www.maihem.ai](https://maihem.ai).
### Setting API key
Before using the maihem package, you need to set your maihem API key as an environment variable. You can add it directly in your python code, or to your local bash script.
#### Alternative 1: In python code
In the beggining of your code add the following lines with your corresponding API key:
```
import os
os.environ['MAIHEM_API_KEY'] = '<your_maihem_api_key>'
```
#### Alternative 2: In local bash script
**For Linux**:
Open the *.bashrc* file in your home directory with a text editor
```
vim ~/.bashrc
```
add the following line to the file with your corresponding API key:
```
export MAIHEM_API_KEY = '<your_maihem_api_key>'
```
Run the following command in the terminal to apply the changes
```
source ~/.bashrc
```
**For Mac**:
Open the *.bash_profile* file in your home directory with a text editor
```
vim ~/.bash_profile
```
add the following line to the file with your corresponding API key:
```
export MAIHEM_API_KEY = '<your_maihem_api_key>'
```
Run the following command in the terminal to apply the changes
```
source ~/.bash_profile
```
## Examples of how to use MAIHEM
- [Simulate conversations between your chatbot and AI personas and evaluate conversations](examples/simulate_and_evaluate_convs.ipynb)
- [Log historical conversations and evaluate them](examples/log_and_evalaute_convs.ipynb)
Raw data
{
"_id": null,
"home_page": null,
"name": "maihem",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "genAI, LLM, evaluation, data, generation, synthetic",
"author": "MAIHEM",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/37/0e/8d3608902a45ff74718db3c5e902b87515067587ca4df0ddc2bb4742f75b/maihem-1.4.2.tar.gz",
"platform": null,
"description": "# maihem\n\n## Introduction\nThe **maihem** python package allows you to simulate personas and generate synthetic text data for training and evaluating your LLMs. It also provides text data evaluations.\n\n## Getting Started\n### Installation\nTo install the API, run the following command:\n```\npip install maihem\n```\n### Obtaining your maihem API key\nRequest a free API key here: [www.maihem.ai](https://maihem.ai).\n\n### Setting API key\nBefore using the maihem package, you need to set your maihem API key as an environment variable. You can add it directly in your python code, or to your local bash script.\n\n#### Alternative 1: In python code\nIn the beggining of your code add the following lines with your corresponding API key:\n\n```\nimport os\n\nos.environ['MAIHEM_API_KEY'] = '<your_maihem_api_key>'\n```\n\n#### Alternative 2: In local bash script\n\n**For Linux**:\n\nOpen the *.bashrc* file in your home directory with a text editor\n```\nvim ~/.bashrc\n```\nadd the following line to the file with your corresponding API key:\n```\nexport MAIHEM_API_KEY = '<your_maihem_api_key>'\n```\n\nRun the following command in the terminal to apply the changes\n```\nsource ~/.bashrc\n```\n\n**For Mac**:\n\nOpen the *.bash_profile* file in your home directory with a text editor\n```\nvim ~/.bash_profile\n```\nadd the following line to the file with your corresponding API key:\n```\nexport MAIHEM_API_KEY = '<your_maihem_api_key>'\n```\n\nRun the following command in the terminal to apply the changes\n```\nsource ~/.bash_profile\n```\n\n## Examples of how to use MAIHEM\n\n- [Simulate conversations between your chatbot and AI personas and evaluate conversations](examples/simulate_and_evaluate_convs.ipynb)\n- [Log historical conversations and evaluate them](examples/log_and_evalaute_convs.ipynb)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 MAIHEM Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "LLM evaluations and synthetic data generation with the MAIHEM models",
"version": "1.4.2",
"project_urls": {
"Homepage": "https://github.com/maihemlabs/maihem"
},
"split_keywords": [
"genai",
" llm",
" evaluation",
" data",
" generation",
" synthetic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01f5b7ea7475aa63f20486c8efdafc8b6e8bbed452e1f1b1245b6ee65059627a",
"md5": "f7cd57ac9cef41f6dc6f3de7a98f6d47",
"sha256": "b82cd7253f0c88c7ce204089c00a2a6aa02564621104fa9fcf7f47ea4a72a827"
},
"downloads": -1,
"filename": "maihem-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f7cd57ac9cef41f6dc6f3de7a98f6d47",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 5983,
"upload_time": "2024-04-16T07:49:40",
"upload_time_iso_8601": "2024-04-16T07:49:40.171622Z",
"url": "https://files.pythonhosted.org/packages/01/f5/b7ea7475aa63f20486c8efdafc8b6e8bbed452e1f1b1245b6ee65059627a/maihem-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "370e8d3608902a45ff74718db3c5e902b87515067587ca4df0ddc2bb4742f75b",
"md5": "552324a33f36b22b4d25d6816e5d5ff8",
"sha256": "1a60a82743b10dc21b3c6cb9e0ddcab3c92c7f2040a5bbfdbfc2b5ca9ca60eb3"
},
"downloads": -1,
"filename": "maihem-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "552324a33f36b22b4d25d6816e5d5ff8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 5261,
"upload_time": "2024-04-16T07:49:41",
"upload_time_iso_8601": "2024-04-16T07:49:41.648595Z",
"url": "https://files.pythonhosted.org/packages/37/0e/8d3608902a45ff74718db3c5e902b87515067587ca4df0ddc2bb4742f75b/maihem-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 07:49:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maihemlabs",
"github_project": "maihem",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "maihem"
}
