# LibreAssist
## Overview
LibreAssist is a Open and Local Assistance program designed to help you with your personal computer needs. It is built
using C++
and utilizes the Llama.cpp framework, along with supporting Llama Models. These models are pre-trained and customized
using the EasyDeL platform, offering a wide range of functionalities tailored to various requirements.
## Features
- **C++ Llama.cpp GGML Framework**: The program is built using the C++ language and utilizes the Llama.cpp framework for
efficient performance.
- **Llama Models**: LibreAssist includes a variety of Llama Models, including pre-trained and customized models tailored
to specific user needs.
- **EasyDeL Platform**: The models have been trained using the EasyDeL platform, ensuring high-quality and accurate
assistance.
- **Customized Models**: Users can access models customized for their specific needs, such as coding assistance, grammar
correction, and more.
## Getting Started
To use LibreAssist, follow these steps:
1. Clone the LibreAssist repository from GitHub.
```shell
git clone https://github.com/erfanzar/LibreAssist.git
```
2. Install the necessary dependencies and libraries as specified in the documentation.
```shell
python -m pip install -r requirements.txt
```
3. Run the program and start utilizing the available models for your personal computer needs.
```shell
python scripts/gradio_launch.py
```
> [!TIP]
> You can use other models too but you need to make sure those model project
> structed just like LinguaMatic Downloading and ggml Formating struct
## System Requirements
LibreAssist is designed to be lightweight and can run on a wide range of personal computers, including low-end PCs with
a minimum of 4GB of RAM and a CPU with good speed.
We hope LibreAssist proves to be a valuable tool for your personal computer needs!
## Usage
LibreAssist provides a diverse set of functionalities, including:
- Coding assistance
- Sentiment analysis
- Language translation
- Chatbots and virtual assistants
- Text summarization
- Named entity recognition
- Question answering systems
- Text classification
- Language generation
- Grammar models
- Information extraction
> [!NOTE]
> Pre-Trained Models for such usage in LibreAssist Are LinguaMatic Models which
> support Coder and Virtual Assistance Models but each one have different
> Model Usage Be Careful with using Them
## Contributing
If you would like to contribute to LibreAssist, please follow the guidelines outlined in the CONTRIBUTING.md file in the
repository.
## License
LibreAssist is licensed under the [Apache v2.0](). See the LICENSE.md file for more details.
## Support
For any questions or issues, please contact me [erfanzare810@gmail.com](erfanzare810@gmail.com).
Thank you for using LibreAssist! We hope it enhances your personal computer experience.
Raw data
{
"_id": null,
"home_page": "https://github.com/erfanzar/LibreAssist",
"name": "LibreAssist",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "machine learning,deep learning,ggml,gguf,c++",
"author": "Erfan Zare Chavoshi",
"author_email": "erfanzare82@eyahoo.com",
"download_url": "https://files.pythonhosted.org/packages/4a/84/78d3383604335d47cea941dcbf3a1e8dda22a43b86c95915b0c94d61d476/LibreAssist-0.0.1.tar.gz",
"platform": null,
"description": "# LibreAssist\n\n## Overview\n\nLibreAssist is a Open and Local Assistance program designed to help you with your personal computer needs. It is built\nusing C++\nand utilizes the Llama.cpp framework, along with supporting Llama Models. These models are pre-trained and customized\nusing the EasyDeL platform, offering a wide range of functionalities tailored to various requirements.\n\n## Features\n\n- **C++ Llama.cpp GGML Framework**: The program is built using the C++ language and utilizes the Llama.cpp framework for\n efficient performance.\n- **Llama Models**: LibreAssist includes a variety of Llama Models, including pre-trained and customized models tailored\n to specific user needs.\n- **EasyDeL Platform**: The models have been trained using the EasyDeL platform, ensuring high-quality and accurate\n assistance.\n- **Customized Models**: Users can access models customized for their specific needs, such as coding assistance, grammar\n correction, and more.\n\n## Getting Started\n\nTo use LibreAssist, follow these steps:\n\n1. Clone the LibreAssist repository from GitHub.\n\n```shell\ngit clone https://github.com/erfanzar/LibreAssist.git\n```\n\n2. Install the necessary dependencies and libraries as specified in the documentation.\n\n```shell\npython -m pip install -r requirements.txt\n```\n\n3. Run the program and start utilizing the available models for your personal computer needs.\n\n\n```shell\npython scripts/gradio_launch.py\n```\n\n> [!TIP]\n> You can use other models too but you need to make sure those model project\n> structed just like LinguaMatic Downloading and ggml Formating struct\n\n## System Requirements\n\nLibreAssist is designed to be lightweight and can run on a wide range of personal computers, including low-end PCs with\na minimum of 4GB of RAM and a CPU with good speed.\n\nWe hope LibreAssist proves to be a valuable tool for your personal computer needs!\n\n## Usage\n\nLibreAssist provides a diverse set of functionalities, including:\n\n- Coding assistance\n- Sentiment analysis\n- Language translation\n- Chatbots and virtual assistants\n- Text summarization\n- Named entity recognition\n- Question answering systems\n- Text classification\n- Language generation\n- Grammar models\n- Information extraction\n\n> [!NOTE]\n> Pre-Trained Models for such usage in LibreAssist Are LinguaMatic Models which\n> support Coder and Virtual Assistance Models but each one have different\n> Model Usage Be Careful with using Them\n\n## Contributing\n\nIf you would like to contribute to LibreAssist, please follow the guidelines outlined in the CONTRIBUTING.md file in the\nrepository.\n\n## License\n\nLibreAssist is licensed under the [Apache v2.0](). See the LICENSE.md file for more details.\n\n## Support\n\nFor any questions or issues, please contact me [erfanzare810@gmail.com](erfanzare810@gmail.com).\n\nThank you for using LibreAssist! We hope it enhances your personal computer experience.\n",
"bugtrack_url": null,
"license": "",
"summary": "An open-source library LibreAssist is a Local Assistance here to help you with your needs on your personal computer",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/erfanzar/LibreAssist"
},
"split_keywords": [
"machine learning",
"deep learning",
"ggml",
"gguf",
"c++"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59dcaa72c542252b2e47cc797900a84db936e633923cb00d9c6f44d56c943acb",
"md5": "87f21a3f2a94abdf46fd4d078f12517d",
"sha256": "8502dbe01d99e5aed8bffaddf16288e362dddd1672f697335e1fc140c25049a8"
},
"downloads": -1,
"filename": "LibreAssist-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87f21a3f2a94abdf46fd4d078f12517d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17504,
"upload_time": "2023-12-23T13:59:06",
"upload_time_iso_8601": "2023-12-23T13:59:06.886129Z",
"url": "https://files.pythonhosted.org/packages/59/dc/aa72c542252b2e47cc797900a84db936e633923cb00d9c6f44d56c943acb/LibreAssist-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a8478d3383604335d47cea941dcbf3a1e8dda22a43b86c95915b0c94d61d476",
"md5": "0efb842182ded3249af2c7b1a9347de3",
"sha256": "88bc8c6a86b2d63e7b8ffa544b4200ce3660edbd05b90a1fab7368962fc56459"
},
"downloads": -1,
"filename": "LibreAssist-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "0efb842182ded3249af2c7b1a9347de3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16393,
"upload_time": "2023-12-23T13:59:09",
"upload_time_iso_8601": "2023-12-23T13:59:09.244051Z",
"url": "https://files.pythonhosted.org/packages/4a/84/78d3383604335d47cea941dcbf3a1e8dda22a43b86c95915b0c94d61d476/LibreAssist-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-23 13:59:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "erfanzar",
"github_project": "LibreAssist",
"github_not_found": true,
"lcname": "libreassist"
}
JSON
