Donut-LLM-Tools


NameDonut-LLM-Tools JSON
Version 24.5.28 PyPI version JSON
download
home_pageNone
SummaryTools for creating datasets, training and loading AI models
upload_time2024-05-28 10:36:52
maintainerNone
docs_urlNone
authorGautham Nair
requires_python<3.12,>=3.9
licenseMIT License Copyright (c) 2024 Gautham Nair 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 ai ml train model dataset
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Donut LLM Tools
Donut LLM Tools is a suite of two programs that helps you create dataset from wikipedia data and your own LLM with the created or already existing dataset.

*Latest Version 24.05.28*

## How to install, import and use DonutLLM?
### Installation
* Before installing Donut LLM Tools, make sure you have Python `3.9` or later till Python `3.11`. *Note : Python `3.12` is not supported by PyTorch, hence Donut LLM Tools will also have trouble running in it.* 
* The dependencies for installing Donut LLM Tools are:
    1. CreateLLM (`pip install CreateLLM`)
    2. torch (Required by CreateLLM)
    3. torchvision (Required by CreateLLM, PyTorch)
    4. torchaudio (Required by CreateLLM, PyTorch)
    5. Wikipedia
    
    *Note : You need to check [PyTorch](https://pytorch.org) website to find more about installation on devices with only CPU or with GPU. Donut LLM Tools support CPU, however it is very slow to train a model in CPU.*
* After ensuring the installation of the above mentioned dependencies, do `pip install donutllmtools`.
* You have now installed Donut LLM Tools in your device.

### Importing and Using
```python
from donutllmtools import Tools

Tools.DatasetCreator() # For creating wikipedia based datasets.

Tools.LLMCreator() # For creating/loading AI model from the above created dataset or a custom dataset.
```

The above code snippet is used to create a dataset and also train/load an AI model

```python
from donutllmtools import HelpAndInfo

HelpAndInfo.help() # To view help.

HelpAndInfo.about() # To view details of the program.

HelpAndInfo.create_llm() # Also create LLM from HelpAndInfo class.

HelpAndInfo.create_dataset() # ALso create dataset from HelpAndInfo class.

HelpAndInfo.main() # To get a menu based interface for dataset creation or model load/creation.
```
The above code uses `HelpAndInfo` class which has the same functions from Tools class as well as help functions.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "Donut-LLM-Tools",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.9",
    "maintainer_email": null,
    "keywords": "AI, ML, Train, Model, Dataset",
    "author": "Gautham Nair",
    "author_email": "gautham.nair.2005@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/94/2b/5c8378d6859cd70af0c2f8fcaa3874646f816845cfb9789d06f5009d2dd2/donut_llm_tools-24.5.28.tar.gz",
    "platform": null,
    "description": "# Donut LLM Tools\r\nDonut LLM Tools is a suite of two programs that helps you create dataset from wikipedia data and your own LLM with the created or already existing dataset.\r\n\r\n*Latest Version 24.05.28*\r\n\r\n## How to install, import and use DonutLLM?\r\n### Installation\r\n* Before installing Donut LLM Tools, make sure you have Python `3.9` or later till Python `3.11`. *Note : Python `3.12` is not supported by PyTorch, hence Donut LLM Tools will also have trouble running in it.* \r\n* The dependencies for installing Donut LLM Tools are:\r\n    1. CreateLLM (`pip install CreateLLM`)\r\n    2. torch (Required by CreateLLM)\r\n    3. torchvision (Required by CreateLLM, PyTorch)\r\n    4. torchaudio (Required by CreateLLM, PyTorch)\r\n    5. Wikipedia\r\n    \r\n    *Note : You need to check [PyTorch](https://pytorch.org) website to find more about installation on devices with only CPU or with GPU. Donut LLM Tools support CPU, however it is very slow to train a model in CPU.*\r\n* After ensuring the installation of the above mentioned dependencies, do `pip install donutllmtools`.\r\n* You have now installed Donut LLM Tools in your device.\r\n\r\n### Importing and Using\r\n```python\r\nfrom donutllmtools import Tools\r\n\r\nTools.DatasetCreator() # For creating wikipedia based datasets.\r\n\r\nTools.LLMCreator() # For creating/loading AI model from the above created dataset or a custom dataset.\r\n```\r\n\r\nThe above code snippet is used to create a dataset and also train/load an AI model\r\n\r\n```python\r\nfrom donutllmtools import HelpAndInfo\r\n\r\nHelpAndInfo.help() # To view help.\r\n\r\nHelpAndInfo.about() # To view details of the program.\r\n\r\nHelpAndInfo.create_llm() # Also create LLM from HelpAndInfo class.\r\n\r\nHelpAndInfo.create_dataset() # ALso create dataset from HelpAndInfo class.\r\n\r\nHelpAndInfo.main() # To get a menu based interface for dataset creation or model load/creation.\r\n```\r\nThe above code uses `HelpAndInfo` class which has the same functions from Tools class as well as help functions.\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Gautham Nair  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": "Tools for creating datasets, training and loading AI models",
    "version": "24.5.28",
    "project_urls": {
        "Homepage": "https://github.com/gauthamnair2005/donut-llm-tools"
    },
    "split_keywords": [
        "ai",
        " ml",
        " train",
        " model",
        " dataset"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4ee7678c22b98728bce2089f88d9f1b47791cfbe9a7ee79a2b01b067bc9ccb0d",
                "md5": "793bf3083ad0ef6d053ad7d95ab9cefa",
                "sha256": "c91e4cc17178cd9a013c9654313156250b2da0317b583450d0ac5ea80c35022f"
            },
            "downloads": -1,
            "filename": "Donut_LLM_Tools-24.5.28-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "793bf3083ad0ef6d053ad7d95ab9cefa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.9",
            "size": 4865,
            "upload_time": "2024-05-28T10:36:50",
            "upload_time_iso_8601": "2024-05-28T10:36:50.703773Z",
            "url": "https://files.pythonhosted.org/packages/4e/e7/678c22b98728bce2089f88d9f1b47791cfbe9a7ee79a2b01b067bc9ccb0d/Donut_LLM_Tools-24.5.28-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "942b5c8378d6859cd70af0c2f8fcaa3874646f816845cfb9789d06f5009d2dd2",
                "md5": "3df4b96d7fb1e1c81d5f468d2be43798",
                "sha256": "99f6a91c1e3d9abc9046ef5d22cf702af3ac780060c033c3f2f72bd24bd8de46"
            },
            "downloads": -1,
            "filename": "donut_llm_tools-24.5.28.tar.gz",
            "has_sig": false,
            "md5_digest": "3df4b96d7fb1e1c81d5f468d2be43798",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.9",
            "size": 4574,
            "upload_time": "2024-05-28T10:36:52",
            "upload_time_iso_8601": "2024-05-28T10:36:52.650799Z",
            "url": "https://files.pythonhosted.org/packages/94/2b/5c8378d6859cd70af0c2f8fcaa3874646f816845cfb9789d06f5009d2dd2/donut_llm_tools-24.5.28.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-28 10:36:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gauthamnair2005",
    "github_project": "donut-llm-tools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "donut-llm-tools"
}
        
Elapsed time: 0.77150s