# Ratchada_Utils
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI version](https://badge.fury.io/py/ratchada-utils.svg)](https://badge.fury.io/py/ratchada-utils)
[![Python Versions](https://img.shields.io/pypi/pyversions/ratchada-utils.svg)](https://pypi.org/project/ratchada-utils/)
A Python library for text processing and utilities related to the Ratchada Whisper model.
## Installation
You can install `ratchada_utils` using pip:
```bash
pip install ratchada_utils
```
To install from source, clone the repository and run:
```bash
git clone https://github.com/yourusername/ratchada_utils.git
cd ratchada_utils
pip install .
```
## Usage
### Tokenizing Text
```bash
from ratchada_utils.processor import tokenize_text
text = "Your input text here."
tokenized_text = tokenize_text(text, pred=True)
print("Tokenized Text:", tokenized_text)
# Tokenized Text: ['your', 'input', 'text', 'here']
```
### Evaluate Performance
```bash
from ratchada_utils.evaluator import simple_evaluator
result = pd.read_csv("./output/result-whisper-ratchada.csv")
summary = simple_evaluator(result["pred_text"], result["true_text"])
```
## Requirements
1. Python 3.10 or higher
2. The Requirements are located in `requirements.txt`
## License
This project is licensed under the MIT License - see the `LICENSE` file for details.
## Contact
Please made contact on the [official repository](https://github.com/thinkingmachines/set-speechtotext-poc) of this project.
Raw data
{
"_id": null,
"home_page": "https://github.com/thinkingmachines/ratchada-utils/",
"name": "ratchada-utils",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": null,
"keywords": "model, Ratchada-Whisper, tokenizing, language, natural language, text analytics",
"author": "tm-zoon",
"author_email": "zoon_p@thinkingmachin.es",
"download_url": "https://files.pythonhosted.org/packages/43/2c/33ebb71409a1a2ef2d4d27093043cc46991d74f1480325e025715e32de37/ratchada_utils-2.2.6.tar.gz",
"platform": null,
"description": "# Ratchada_Utils\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![PyPI version](https://badge.fury.io/py/ratchada-utils.svg)](https://badge.fury.io/py/ratchada-utils)\n[![Python Versions](https://img.shields.io/pypi/pyversions/ratchada-utils.svg)](https://pypi.org/project/ratchada-utils/)\n\nA Python library for text processing and utilities related to the Ratchada Whisper model.\n\n## Installation\n\nYou can install `ratchada_utils` using pip:\n\n```bash\npip install ratchada_utils\n```\n\nTo install from source, clone the repository and run:\n\n```bash\ngit clone https://github.com/yourusername/ratchada_utils.git\ncd ratchada_utils\npip install .\n```\n\n## Usage\n\n### Tokenizing Text\n\n```bash\n\nfrom ratchada_utils.processor import tokenize_text\n\ntext = \"Your input text here.\"\ntokenized_text = tokenize_text(text, pred=True)\nprint(\"Tokenized Text:\", tokenized_text)\n# Tokenized Text: ['your', 'input', 'text', 'here']\n```\n\n### Evaluate Performance\n\n```bash\nfrom ratchada_utils.evaluator import simple_evaluator\n\nresult = pd.read_csv(\"./output/result-whisper-ratchada.csv\")\n\nsummary = simple_evaluator(result[\"pred_text\"], result[\"true_text\"])\n```\n\n## Requirements\n\n1. Python 3.10 or higher\n2. The Requirements are located in `requirements.txt`\n\n## License\n\nThis project is licensed under the MIT License - see the `LICENSE` file for details.\n\n## Contact\n\nPlease made contact on the [official repository](https://github.com/thinkingmachines/set-speechtotext-poc) of this project.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Ratchada Utils are Python package use with Ratchada Whisper model utilities.",
"version": "2.2.6",
"project_urls": {
"Documentation": "https://huggingface.co/ThinkingMachinesDataScience/Ratchada-Fang-Thon-Whisper",
"Homepage": "https://github.com/thinkingmachines/ratchada-utils/",
"Issue Tracker": "https://github.com/thinkingmachines/ratchada-utils/issues",
"Source Code": "https://github.com/thinkingmachines/ratchada-utils"
},
"split_keywords": [
"model",
" ratchada-whisper",
" tokenizing",
" language",
" natural language",
" text analytics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b9b94fa9eb861c3e878d55147ebe0e4d5c94687bb2acc04c974c9daa132c20e",
"md5": "7a0d59ba9a77a75d517d4a7880dbb2d7",
"sha256": "01dfd7b47767fa7bb131b4aeed99b08c4fa420e5af78fe321cc6cadbf7cf6e21"
},
"downloads": -1,
"filename": "ratchada_utils-2.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a0d59ba9a77a75d517d4a7880dbb2d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 26011,
"upload_time": "2024-07-30T11:30:30",
"upload_time_iso_8601": "2024-07-30T11:30:30.283165Z",
"url": "https://files.pythonhosted.org/packages/8b/9b/94fa9eb861c3e878d55147ebe0e4d5c94687bb2acc04c974c9daa132c20e/ratchada_utils-2.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "432c33ebb71409a1a2ef2d4d27093043cc46991d74f1480325e025715e32de37",
"md5": "58cade532ac3eddc66b54863ddeb4715",
"sha256": "e73cbc2f95c6ed75b6fe81baa8a41f88214bb91cb2224228d27e936b28a12db9"
},
"downloads": -1,
"filename": "ratchada_utils-2.2.6.tar.gz",
"has_sig": false,
"md5_digest": "58cade532ac3eddc66b54863ddeb4715",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 26519,
"upload_time": "2024-07-30T11:30:31",
"upload_time_iso_8601": "2024-07-30T11:30:31.575972Z",
"url": "https://files.pythonhosted.org/packages/43/2c/33ebb71409a1a2ef2d4d27093043cc46991d74f1480325e025715e32de37/ratchada_utils-2.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 11:30:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thinkingmachines",
"github_project": "ratchada-utils",
"github_not_found": true,
"lcname": "ratchada-utils"
}