๐Ÿง™ Overview: Unleash Your LLM Superpowersยถ

๐Ÿช„ What is CellMage?ยถ

CellMage is your magical companion for Jupyter notebooks, transforming ordinary code cells into powerful LLM interactions! Think of it as having an AI wizard ๐Ÿง™โ€โ™‚๏ธ sitting right next to you while you code, ready to assist whenever you summon it.

Under the hood, CellMage consists of several powerful magical components working together:

  • ๐Ÿง  ChatManager: The central orchestrator that handles LLM interactions and manages the conversation flow

  • ๐Ÿ“œ HistoryManager: (Deprecated) Previously kept track of your conversation history and managed message persistence. Use ConversationManager instead.

  • ๐ŸŽญ Personas: Predefined AI personalities with specific system prompts and parameters

  • ๐Ÿ“‹ Snippets: Reusable context blocks that can be injected into conversations

  • ๐Ÿ”Œ Adapters: Connects to different LLM providers (OpenAI, compatible APIs, and more)

  • ๐Ÿ’พ Storage: Saves your conversations using SQLite (default) or Markdown files for easy reference

  • ๐Ÿงฉ Integrations: Links CellMage to external tools like Jira, GitHub, GitLab, and Confluence

All these components work seamlessly together to create a frictionless LLM experience in your notebook environment.

โœจ A Sprinkle of Magic Dustยถ

With CellMage, you can:

  • ๐Ÿ’ฌ Chat with sophisticated AI models using simple %%llm magic commands

  • ๐ŸŽญ Switch between different AI personalities (personas) with a flick of your wand

  • ๐Ÿ”ฎ Turn your entire notebook into an AI chat interface with Ambient Mode

  • ๐Ÿ“š Save your magical conversations for later reference

  • ๐Ÿงฉ Connect to external knowledge sources like GitHub, GitLab, Jira, and Confluence

  • โšก Execute Python code generated by the LLM right in your notebook

๐Ÿš€ Getting Started in 10 Secondsยถ

# Install the magic
!pip install cellmage

# Load the extension
%load_ext cellmage

# Cast your first spell!
%%llm
Tell me a fun fact about wizards in computing history.

๐ŸŽฏ Perfect Forโ€ฆยถ

  • ๐Ÿงช Data scientists exploring datasets with AI assistance

  • ๐Ÿ’ป Developers getting code explanations and suggestions

  • ๐Ÿ“ Writers crafting documentation with AI help

  • ๐ŸŽ“ Students learning new concepts interactively

  • ๐Ÿ” Researchers analyzing complex information

  • โš™๏ธ Automating repetitive LLM tasks in data workflows

Ready to start your magical journey? Check out the Magic Commands to learn all the spells in your new wizard toolkit!