llm-embed-jina


Namellm-embed-jina JSON
Version 0.1.2 PyPI version JSON
download
home_page
SummaryEmbedding models from Jina AI
upload_time2023-10-26 03:09:09
maintainer
docs_urlNone
authorSimon Willison
requires_python
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # llm-embed-jina

[![PyPI](https://img.shields.io/pypi/v/llm-embed-jina.svg)](https://pypi.org/project/llm-embed-jina/)
[![Changelog](https://img.shields.io/github/v/release/simonw/llm-embed-jina?include_prereleases&label=changelog)](https://github.com/simonw/llm-embed-jina/releases)
[![Tests](https://github.com/simonw/llm-embed-jina/workflows/Test/badge.svg)](https://github.com/simonw/llm-embed-jina/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/llm-embed-jina/blob/main/LICENSE)

Embedding models from Jina AI

## Background

[Jina AI Launches World's First Open-Source 8K Text Embedding, Rivaling OpenAI](https://jina.ai/news/jina-ai-launches-worlds-first-open-source-8k-text-embedding-rivaling-openai/) introduces these models.

See also [Embeddings: What they are and why they matter](https://simonwillison.net/2023/Oct/23/embeddings/) for background on embeddings and an explanation of the LLM embeddings tool.

## Installation

Install this plugin in the same environment as [LLM](https://llm.datasette.io/).

    llm install llm-embed-jina

## Usage

This plugin adds support for three new embedding models:

- [`jina-embeddings-v2-small-en`](https://huggingface.co/jinaai/jina-embeddings-v2-small-en): 33 million parameters.
- [`jina-embeddings-v2-base-en`](https://huggingface.co/jinaai/jina-embeddings-v2-base-en): 137 million parameters.
- [`jina-embeddings-v2-large-en`](https://huggingface.co/jinaai/jina-embeddings-v2-large-en): 435 million parameters - not yet released, but it will work once it has been released.

The models will be downloaded the first time you try to use them.

See [the LLM documentation](https://llm.datasette.io/en/stable/embeddings/index.html) for everything you can do.

To get started embedding a single string, run the following:

```bash
llm embed -m jina-embeddings-v2-small-en -c 'Hello world'
```
This will output a JSON array of 512 floating point numbers to your terminal.

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:
```bash
cd llm-embed-jina
python3 -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
llm install -e '.[test]'
```
To run the tests:
```bash
pytest
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "llm-embed-jina",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Simon Willison",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/a0/07/8f007599ba9cbd00a031b09e4e7109da20d8e0f8503e3fd5569287a84d36/llm-embed-jina-0.1.2.tar.gz",
    "platform": null,
    "description": "# llm-embed-jina\n\n[![PyPI](https://img.shields.io/pypi/v/llm-embed-jina.svg)](https://pypi.org/project/llm-embed-jina/)\n[![Changelog](https://img.shields.io/github/v/release/simonw/llm-embed-jina?include_prereleases&label=changelog)](https://github.com/simonw/llm-embed-jina/releases)\n[![Tests](https://github.com/simonw/llm-embed-jina/workflows/Test/badge.svg)](https://github.com/simonw/llm-embed-jina/actions?query=workflow%3ATest)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/llm-embed-jina/blob/main/LICENSE)\n\nEmbedding models from Jina AI\n\n## Background\n\n[Jina AI Launches World's First Open-Source 8K Text Embedding, Rivaling OpenAI](https://jina.ai/news/jina-ai-launches-worlds-first-open-source-8k-text-embedding-rivaling-openai/) introduces these models.\n\nSee also [Embeddings: What they are and why they matter](https://simonwillison.net/2023/Oct/23/embeddings/) for background on embeddings and an explanation of the LLM embeddings tool.\n\n## Installation\n\nInstall this plugin in the same environment as [LLM](https://llm.datasette.io/).\n\n    llm install llm-embed-jina\n\n## Usage\n\nThis plugin adds support for three new embedding models:\n\n- [`jina-embeddings-v2-small-en`](https://huggingface.co/jinaai/jina-embeddings-v2-small-en): 33 million parameters.\n- [`jina-embeddings-v2-base-en`](https://huggingface.co/jinaai/jina-embeddings-v2-base-en): 137 million parameters.\n- [`jina-embeddings-v2-large-en`](https://huggingface.co/jinaai/jina-embeddings-v2-large-en): 435 million parameters - not yet released, but it will work once it has been released.\n\nThe models will be downloaded the first time you try to use them.\n\nSee [the LLM documentation](https://llm.datasette.io/en/stable/embeddings/index.html) for everything you can do.\n\nTo get started embedding a single string, run the following:\n\n```bash\nllm embed -m jina-embeddings-v2-small-en -c 'Hello world'\n```\nThis will output a JSON array of 512 floating point numbers to your terminal.\n\n## Development\n\nTo set up this plugin locally, first checkout the code. Then create a new virtual environment:\n```bash\ncd llm-embed-jina\npython3 -m venv venv\nsource venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```bash\nllm install -e '.[test]'\n```\nTo run the tests:\n```bash\npytest\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Embedding models from Jina AI",
    "version": "0.1.2",
    "project_urls": {
        "CI": "https://github.com/simonw/llm-embed-jina/actions",
        "Changelog": "https://github.com/simonw/llm-embed-jina/releases",
        "Homepage": "https://github.com/simonw/llm-embed-jina",
        "Issues": "https://github.com/simonw/llm-embed-jina/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4c100332ef43aa532cd1bdab8195174641454da52de008e03c031f6e3a6719a0",
                "md5": "4011b80460d282b9e323164a3c10df96",
                "sha256": "86df8af03955ef4c1bac250b69c572a6f984219c655c1b071a96a4e37ca63391"
            },
            "downloads": -1,
            "filename": "llm_embed_jina-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4011b80460d282b9e323164a3c10df96",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7118,
            "upload_time": "2023-10-26T03:09:07",
            "upload_time_iso_8601": "2023-10-26T03:09:07.904820Z",
            "url": "https://files.pythonhosted.org/packages/4c/10/0332ef43aa532cd1bdab8195174641454da52de008e03c031f6e3a6719a0/llm_embed_jina-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a0078f007599ba9cbd00a031b09e4e7109da20d8e0f8503e3fd5569287a84d36",
                "md5": "45a4e0d766e76e2117288e9ae715d6ed",
                "sha256": "73d7e31775cb0b85b4eea6ff1e6ab58c7c43c09804fa6555015a82fefb385739"
            },
            "downloads": -1,
            "filename": "llm-embed-jina-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "45a4e0d766e76e2117288e9ae715d6ed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7033,
            "upload_time": "2023-10-26T03:09:09",
            "upload_time_iso_8601": "2023-10-26T03:09:09.683051Z",
            "url": "https://files.pythonhosted.org/packages/a0/07/8f007599ba9cbd00a031b09e4e7109da20d8e0f8503e3fd5569287a84d36/llm-embed-jina-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-26 03:09:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simonw",
    "github_project": "llm-embed-jina",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "llm-embed-jina"
}
        
Elapsed time: 0.42902s