Skip to main content

A Jupyter kernel for communicating with large language models

Project description

ipy-llm-kernel

ipy-llm-kernel is a Jupyter kernel that allows you to type in English language and receive responses from a large language model (LLM).

img_1.png

It can make use of OpenAI's chatGPT, Anthropic's Claude, Helmholtz' blablador and Ollama. You need an OpenAI API, Anthropic, Google or a Helmholtz account to use it. Using it with Ollama is free but requires running an Ollama server locally.

[!CAUTION] When using the OpenAI, Google Gemini, Anthropic or any other endpoint via BiA-Bob, you are bound to the terms of service of the respective companies or organizations. The prompts you enter are transferred to their servers and may be processed and stored there. Make sure to not submit any sensitive, confidential or personal data. Also using these services may cost money.

Usage

After starting jupyter lab, select the LLM Kernel.

img.png

You can then type in English language and receive responses from the LLM as demonstrated above

Generating images

If your prompt asks for generating images, it may generate this image for you. At the moment, only OpenAI/Dall-E3 is supported for this. You need an OpenAI API Key for this.

img.png

Installation

First, you should also create an environment variable named "IPY_LLM_KERNEL_MODEL" and enter a model name depending on which service provider you want to use. Examples:

  • llama3:8b
  • blablador:alias:large
  • claude-3-5-sonnet-20240620
  • gpt-4o-2024-08-06

Then, start a new terminal to install ipy-llm-kernel using pip. It is recommended to install it into via conda/mamba environment. If you have never used conda before, please read this guide first.

pip install ipy-llm-kernel

Afterwards, run additionally this command:

python -m ipy_llm_kernel install

You can check if it's installed by printing out the list of installed kernels:

jupyter kernelspec list

And you can uninstall them using this command:

jupyter kernelspec uninstall llm-kernel

Development

If you want to contribute to ipy-llm-kernel, you can install it in development mode like this:

git clone https://github.com/haesleinhuepf/ipy-llm-kernel.git
cd ipy-llm-kernel
pip install -e .

Similar projects

There are similar projects:

Issues

If you encounter any problems or want to provide feedback or suggestions, please create an issue along with a detailed description and tag @haesleinhuepf .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipy_llm_kernel-0.2.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

ipy_llm_kernel-0.2.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file ipy_llm_kernel-0.2.0.tar.gz.

File metadata

  • Download URL: ipy_llm_kernel-0.2.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for ipy_llm_kernel-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5b86c7d846f62f6b203a69d9fb4eb4358714ec3d8485e8bc0464ca2058191d9a
MD5 fe96d5186b3ec5b3e3e7db185743b0fe
BLAKE2b-256 f287f284b28959a27cf372758b48d947fa1c6b2da011e21824f4eadc63d312f2

See more details on using hashes here.

File details

Details for the file ipy_llm_kernel-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ipy_llm_kernel-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b82046f2adfbfa0387cfa665f8404e47496d52247c0bfd6a6a6cc7cd18efbe52
MD5 3eeb9cfa2428804c3f211f369a48389f
BLAKE2b-256 642ca7c396d6ba01746ab8392cc2b070902811ab7a5272a536929d775a02bd77

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page