pycardinal

Name	pycardinal JSON
Version	0.3.0 JSON
	download
home_page	https://github.com/the-seeds/cardinal
Summary	None
upload_time	2024-12-18 09:35:28
maintainer	None
docs_url	None
author	the-seeds
requires_python	>=3.9.0
license	Apache 2.0 License
keywords	llm
VCS
bugtrack_url
requirements	openai pydantic
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Cardinal

[![GitHub Code License](https://img.shields.io/github/license/the-seeds/cardinal)](LICENSE)
[![PyPI](https://img.shields.io/pypi/v/pycardinal)](https://pypi.org/project/pycardinal/)

## Usage

Create a `.env` file in the `api_demo` directory:

```
api_demo
├── utils
└── .env
```

```
# imitater or openai
OPENAI_BASE_URL=http://localhost:8000/v1
OPENAI_API_KEY=0

# models
DEFAULT_EMBED_MODEL=text-embedding-ada-002
DEFAULT_CHAT_MODEL=gpt-3.5-turbo
HF_TOKENIZER_PATH=01-ai/Yi-6B-Chat

# text splitter
DEFAULT_CHUNK_SIZE=300
DEFAULT_CHUNK_OVERLAP=100

# storages
STORAGE=redis
SEARCH_TARGET=content
REDIS_URI=redis://localhost:6379
ELASTICSEARCH_URI=http://localhost:9001

# graph storage
GRAPH_STORAGE=neo4j
NEO4J_URI=bolt://localhost:7687

# vectorstore
VECTORSTORE=chroma
CHROMA_PATH=./chroma
MILVUS_URI=http://localhost:19530
MILVUS_TOKEN=0
```

Run `python launch.py --config config.yaml --action build`

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/the-seeds/cardinal",
    "name": "pycardinal",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9.0",
    "maintainer_email": null,
    "keywords": "LLM",
    "author": "the-seeds",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# Cardinal\n\n[![GitHub Code License](https://img.shields.io/github/license/the-seeds/cardinal)](LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/pycardinal)](https://pypi.org/project/pycardinal/)\n\n## Usage\n\nCreate a `.env` file in the `api_demo` directory:\n\n```\napi_demo\n\u251c\u2500\u2500 utils\n\u2514\u2500\u2500 .env\n```\n\n```\n# imitater or openai\nOPENAI_BASE_URL=http://localhost:8000/v1\nOPENAI_API_KEY=0\n\n# models\nDEFAULT_EMBED_MODEL=text-embedding-ada-002\nDEFAULT_CHAT_MODEL=gpt-3.5-turbo\nHF_TOKENIZER_PATH=01-ai/Yi-6B-Chat\n\n# text splitter\nDEFAULT_CHUNK_SIZE=300\nDEFAULT_CHUNK_OVERLAP=100\n\n# storages\nSTORAGE=redis\nSEARCH_TARGET=content\nREDIS_URI=redis://localhost:6379\nELASTICSEARCH_URI=http://localhost:9001\n\n# graph storage\nGRAPH_STORAGE=neo4j\nNEO4J_URI=bolt://localhost:7687\n\n# vectorstore\nVECTORSTORE=chroma\nCHROMA_PATH=./chroma\nMILVUS_URI=http://localhost:19530\nMILVUS_TOKEN=0\n```\n\nRun `python launch.py --config config.yaml --action build`\n",
    "bugtrack_url": null,
    "license": "Apache 2.0 License",
    "summary": null,
    "version": "0.3.0",
    "project_urls": {
        "Homepage": "https://github.com/the-seeds/cardinal"
    },
    "split_keywords": [
        "llm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c9b154f9c1b17221b4976efc7a2fed312d8122694a7cbb8ffad0abcd19a738b1",
                "md5": "abcf707e48d38cf7cfdc7c3120d588b1",
                "sha256": "0597797ed0cbddeed0558ad41afc4b9ac835045317ee3fa0ae9a65080d0bdfb7"
            },
            "downloads": -1,
            "filename": "pycardinal-0.3.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "abcf707e48d38cf7cfdc7c3120d588b1",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.9.0",
            "size": 33765,
            "upload_time": "2024-12-18T09:35:28",
            "upload_time_iso_8601": "2024-12-18T09:35:28.572788Z",
            "url": "https://files.pythonhosted.org/packages/c9/b1/54f9c1b17221b4976efc7a2fed312d8122694a7cbb8ffad0abcd19a738b1/pycardinal-0.3.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-18 09:35:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "the-seeds",
    "github_project": "cardinal",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "openai",
            "specs": [
                [
                    ">=",
                    "1.5.0"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    ">=",
                    "2.0.0"
                ]
            ]
        }
    ],
    "lcname": "pycardinal"
}