OpenCHA


NameOpenCHA JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/Institute4FutureHealth/CHA.git
SummaryConversational Health Agents (CHAs) are interactive systems designed to enhance personalhealthcare services by engaging in empathetic conversations and processing multimodal data.
upload_time2024-07-08 05:43:58
maintainerNone
docs_urlNone
authorMahyar Abbasian
requires_python<3.12,>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            Quick Start
===========
* [Documentation page](https://docs.opencha.com)
* [User Guide](https://docs.opencha.com/user_guide/index.html)
* [How to Contribute](https://docs.opencha.com/user_guide/contribute.html)
* [API Docs](https://docs.opencha.com/api/index.html)
* [Examples](https://docs.opencha.com/examples/index.html)

To use CHA in a safe and stable way, ensure you have Python 3.10 or higher installed. First, create a virtual environment:

```python
# Create the virtual environment
python -m venv /path/to/new/virtual/environment

# Activate the virtual environment
source /path/to/new/virtual/environment/bin/activate
```

Now, install the CHA package. Unfortunately, currently due to PyPi registration problem, we could not upload our package to be
installed via pip directly. For now you can simply clone our code and do the installation as follows:

```bash
git clone https://github.com/Institute4FutureHealth/CHA.git
cd CHA
pip install '.[all]'
```

To simplify installation with minimum requirements and be ready to go, you can use the following command. This installs OpenAI, React Planner, as well as SerpAPI (search) and Playwright (browser) tasks:

```bash
pip install '.[minimum]'
```

If you want to install all requirements for all tasks and other components, use the following command:

```bash
pip install '.[all]'
```

After installing the package, based on what tasks you want to use, you may need to acquire some api_keys. For example, to get started using openAI GPT3.5 model as LLM in CHA, you need to signup
in their website and get the api_key. Then you should add openAI api_key as environment vairable in your terminal:

```bash
export OPENAI_API_KEY="your api_key"
```

The same goes for using tasks like SerpAPI:

```bash
export SERPAPI_API_KEY="your api_key"
```

Finally, you can start running our framework with the following simple code:

```python
from src.CHA import CHA

cha = CHA()
cha.run_with_interface()
```

This code will run the default interface, and you can access it at the following URL:

**http://127.0.0.1:7860**

For more examples, visit the [Examples page](https://docs.opencha.com/examples/index.html).

![Alt Text](./docs/figs/Interface.png)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Institute4FutureHealth/CHA.git",
    "name": "OpenCHA",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Mahyar Abbasian",
    "author_email": "example@email.com",
    "download_url": "https://files.pythonhosted.org/packages/61/68/3eec58ff3b13244f5c8aec796ecb705bf81c85e945e84ba2534f7e39c27c/opencha-1.1.0.tar.gz",
    "platform": null,
    "description": "Quick Start\n===========\n* [Documentation page](https://docs.opencha.com)\n* [User Guide](https://docs.opencha.com/user_guide/index.html)\n* [How to Contribute](https://docs.opencha.com/user_guide/contribute.html)\n* [API Docs](https://docs.opencha.com/api/index.html)\n* [Examples](https://docs.opencha.com/examples/index.html)\n\nTo use CHA in a safe and stable way, ensure you have Python 3.10 or higher installed. First, create a virtual environment:\n\n```python\n# Create the virtual environment\npython -m venv /path/to/new/virtual/environment\n\n# Activate the virtual environment\nsource /path/to/new/virtual/environment/bin/activate\n```\n\nNow, install the CHA package. Unfortunately, currently due to PyPi registration problem, we could not upload our package to be\ninstalled via pip directly. For now you can simply clone our code and do the installation as follows:\n\n```bash\ngit clone https://github.com/Institute4FutureHealth/CHA.git\ncd CHA\npip install '.[all]'\n```\n\nTo simplify installation with minimum requirements and be ready to go, you can use the following command. This installs OpenAI, React Planner, as well as SerpAPI (search) and Playwright (browser) tasks:\n\n```bash\npip install '.[minimum]'\n```\n\nIf you want to install all requirements for all tasks and other components, use the following command:\n\n```bash\npip install '.[all]'\n```\n\nAfter installing the package, based on what tasks you want to use, you may need to acquire some api_keys. For example, to get started using openAI GPT3.5 model as LLM in CHA, you need to signup\nin their website and get the api_key. Then you should add openAI api_key as environment vairable in your terminal:\n\n```bash\nexport OPENAI_API_KEY=\"your api_key\"\n```\n\nThe same goes for using tasks like SerpAPI:\n\n```bash\nexport SERPAPI_API_KEY=\"your api_key\"\n```\n\nFinally, you can start running our framework with the following simple code:\n\n```python\nfrom src.CHA import CHA\n\ncha = CHA()\ncha.run_with_interface()\n```\n\nThis code will run the default interface, and you can access it at the following URL:\n\n**http://127.0.0.1:7860**\n\nFor more examples, visit the [Examples page](https://docs.opencha.com/examples/index.html).\n\n![Alt Text](./docs/figs/Interface.png)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Conversational Health Agents (CHAs) are interactive systems designed to enhance personalhealthcare services by engaging in empathetic conversations and processing multimodal data.",
    "version": "1.1.0",
    "project_urls": {
        "Download": "https://github.com/user/reponame/archive/v_01.tar.gz",
        "Homepage": "https://github.com/Institute4FutureHealth/CHA.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "61683eec58ff3b13244f5c8aec796ecb705bf81c85e945e84ba2534f7e39c27c",
                "md5": "9a6d3dddd8c37dd651d8d46c713b016c",
                "sha256": "0461baa205423a99dfa21a9308e58e8ce94b97c15cf07773ee4c05961f7ec492"
            },
            "downloads": -1,
            "filename": "opencha-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9a6d3dddd8c37dd651d8d46c713b016c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.9",
            "size": 51236,
            "upload_time": "2024-07-08T05:43:58",
            "upload_time_iso_8601": "2024-07-08T05:43:58.250981Z",
            "url": "https://files.pythonhosted.org/packages/61/68/3eec58ff3b13244f5c8aec796ecb705bf81c85e945e84ba2534f7e39c27c/opencha-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-08 05:43:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Institute4FutureHealth",
    "github_project": "CHA",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "opencha"
}
Mahyar Abbasian
Elapsed time: 0.37004s