ovos-solver-jabir-plugin


Nameovos-solver-jabir-plugin JSON
Version 0.0.0a4 PyPI version JSON
download
home_pagehttps://github.com/TigreGotico/ovos-solver-jabir-plugin
SummaryA question solver plugin for OVOS
upload_time2024-10-25 20:45:01
maintainerNone
docs_urlNone
authorjarbasai
requires_pythonNone
licenseMIT
keywords ovos openvoiceos llm plugin utterance fallback query
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Jabir Solver

## Overview

`JabirLLMSolver` is a question-answering module that utilizes [Jabir](https://jabirproject.org/) models to provide responses to user queries. 

Jabir LLM is a 400 billion parameter model trained on various datasets gathered from all over the internet. The main goal of this project is to be a multilingual and foundamental model for different usecases. We've tested the model on different tasks such as question answering in different languages (mostly English and Persian), code generation, basic reasoning tasks and the model showed a really good performance to all of them and most of the time the results were better than competitors

## Configuration

```python
cfg = {
    "key": "XXX-XXX-XXX-XXX-XXX"
}
```

**NOTE**: api keys are free, a default one will be used if not set in config

## Usage

### Initializing the Solver

```python
from ovos_jabir_solver import JabirLLMSolver
from ovos_utils.log import LOG

LOG.set_level("DEBUG")

cfg = {
    "key": "get-yours-from-url"
}

solver = JabirLLMSolver(cfg)
ans = solver.spoken_answer("when will the world end?")
print(ans)
# A question that has puzzled humans for centuries! As a large language model, I must inform you that predicting the exact date of the world's end is impossible, and it's not supported by scientific evidence.
#
# That being said, there are various theories and hypotheses about the potential risks and threats to human civilization and the planet. Some of these include:
#
# 1. Climate change: Global warming and climate change could have catastrophic consequences, such as rising sea levels, droughts, and extreme weather events, if left unchecked.
# 2. Nuclear war: A large-scale nuclear conflict could cause widespread destruction and potentially lead to the end of human civilization.
# 3. Asteroid impact: A massive asteroid impact could cause massive destruction and potentially lead to the extinction of human life.
# 4. Pandemics: A highly contagious and deadly pandemic could potentially wipe out a significant portion of the global population.
# 5. Ecological collapse: The degradation of ecosystems and loss of biodiversity could have severe consequences for the planet's ability to support life.
#
# However, it's essential to note that these scenarios are not inevitable, and humanity has the capacity to mitigate and prevent them. By working together to address these challenges, we can reduce the risks and create a more sustainable and resilient future.
#
# So, to answer your question, I don't predict the world will end on a specific date. Instead, I emphasize the importance of collective action and responsible stewardship of our planet to ensure a bright and thriving future for all.
```


## Integrating with Persona Framework

To integrate `JabirLLMSolver` with the OVOS Persona Framework, run the OVOS Persona Server with the desired configuration file:

```bash
$ ovos-persona-server --persona jabir_persona_remote.json
```

Replace `jabir_persona_remote.json` with the filename of the configuration you wish to use.


**`jabir_persona_remote.json`**:

```json
{
  "name": "Jabir",
  "solvers": [
    "ovos-solver-jabir-plugin"
  ],
  "ovos-solver-jabir-plugin": {
    "key": "XXX"
  }
}
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/TigreGotico/ovos-solver-jabir-plugin",
    "name": "ovos-solver-jabir-plugin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "OVOS openvoiceos LLM plugin utterance fallback query",
    "author": "jarbasai",
    "author_email": "jarbasai@mailfence.com",
    "download_url": null,
    "platform": null,
    "description": "# Jabir Solver\n\n## Overview\n\n`JabirLLMSolver` is a question-answering module that utilizes [Jabir](https://jabirproject.org/) models to provide responses to user queries. \n\nJabir LLM is a 400 billion parameter model trained on various datasets gathered from all over the internet. The main goal of this project is to be a multilingual and foundamental model for different usecases. We've tested the model on different tasks such as question answering in different languages (mostly English and Persian), code generation, basic reasoning tasks and the model showed a really good performance to all of them and most of the time the results were better than competitors\n\n## Configuration\n\n```python\ncfg = {\n    \"key\": \"XXX-XXX-XXX-XXX-XXX\"\n}\n```\n\n**NOTE**: api keys are free, a default one will be used if not set in config\n\n## Usage\n\n### Initializing the Solver\n\n```python\nfrom ovos_jabir_solver import JabirLLMSolver\nfrom ovos_utils.log import LOG\n\nLOG.set_level(\"DEBUG\")\n\ncfg = {\n    \"key\": \"get-yours-from-url\"\n}\n\nsolver = JabirLLMSolver(cfg)\nans = solver.spoken_answer(\"when will the world end?\")\nprint(ans)\n# A question that has puzzled humans for centuries! As a large language model, I must inform you that predicting the exact date of the world's end is impossible, and it's not supported by scientific evidence.\n#\n# That being said, there are various theories and hypotheses about the potential risks and threats to human civilization and the planet. Some of these include:\n#\n# 1. Climate change: Global warming and climate change could have catastrophic consequences, such as rising sea levels, droughts, and extreme weather events, if left unchecked.\n# 2. Nuclear war: A large-scale nuclear conflict could cause widespread destruction and potentially lead to the end of human civilization.\n# 3. Asteroid impact: A massive asteroid impact could cause massive destruction and potentially lead to the extinction of human life.\n# 4. Pandemics: A highly contagious and deadly pandemic could potentially wipe out a significant portion of the global population.\n# 5. Ecological collapse: The degradation of ecosystems and loss of biodiversity could have severe consequences for the planet's ability to support life.\n#\n# However, it's essential to note that these scenarios are not inevitable, and humanity has the capacity to mitigate and prevent them. By working together to address these challenges, we can reduce the risks and create a more sustainable and resilient future.\n#\n# So, to answer your question, I don't predict the world will end on a specific date. Instead, I emphasize the importance of collective action and responsible stewardship of our planet to ensure a bright and thriving future for all.\n```\n\n\n## Integrating with Persona Framework\n\nTo integrate `JabirLLMSolver` with the OVOS Persona Framework, run the OVOS Persona Server with the desired configuration file:\n\n```bash\n$ ovos-persona-server --persona jabir_persona_remote.json\n```\n\nReplace `jabir_persona_remote.json` with the filename of the configuration you wish to use.\n\n\n**`jabir_persona_remote.json`**:\n\n```json\n{\n  \"name\": \"Jabir\",\n  \"solvers\": [\n    \"ovos-solver-jabir-plugin\"\n  ],\n  \"ovos-solver-jabir-plugin\": {\n    \"key\": \"XXX\"\n  }\n}\n```\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A question solver plugin for OVOS",
    "version": "0.0.0a4",
    "project_urls": {
        "Homepage": "https://github.com/TigreGotico/ovos-solver-jabir-plugin"
    },
    "split_keywords": [
        "ovos",
        "openvoiceos",
        "llm",
        "plugin",
        "utterance",
        "fallback",
        "query"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1fdcf972e635084c888a8d6b974c96252841142d8b576b9192d7a64e2aa8a7cf",
                "md5": "f9e47d2fd8f0a4cbf7445d1ee06f7d9f",
                "sha256": "f9cc42e9ef2ebda9281bb9fd04825b104a94fa58a1086ca5d4826eade038571b"
            },
            "downloads": -1,
            "filename": "ovos_solver_jabir_plugin-0.0.0a4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f9e47d2fd8f0a4cbf7445d1ee06f7d9f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4359,
            "upload_time": "2024-10-25T20:45:01",
            "upload_time_iso_8601": "2024-10-25T20:45:01.609444Z",
            "url": "https://files.pythonhosted.org/packages/1f/dc/f972e635084c888a8d6b974c96252841142d8b576b9192d7a64e2aa8a7cf/ovos_solver_jabir_plugin-0.0.0a4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-25 20:45:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "TigreGotico",
    "github_project": "ovos-solver-jabir-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "ovos-solver-jabir-plugin"
}
        
Elapsed time: 0.42886s