Skip to content

Latest commit

 

History

History
 
 

README.md

Marvin Documentation

This directory contains the documentation for Marvin, a Python framework for building AI applications with LLMs.

Documentation Structure

The documentation is organized into the following sections:

Core Concepts

  • Tasks - The fundamental building blocks of AI workflows
  • Agents - Specialized AI workers with different roles and capabilities
  • Threads - Maintaining conversation context across multiple interactions
  • Teams - Coordinating multiple AI agents to solve complex problems
  • Tools and Context - Extending AI capabilities with custom functions and additional information
  • Memory - Enabling agents to remember information across conversations

Functions

  • run - Execute a task with an LLM
  • classify - Categorize content into predefined classes
  • extract - Pull structured data from unstructured text
  • cast - Convert content to a specified structure
  • generate - Create structured data or content
  • summarize - Create concise summaries of content
  • say - Have conversational interactions with an LLM
  • plan - Create structured plans for complex tasks
  • fn - Create AI-powered functions with a decorator

Guides

Patterns

Contributing to Documentation

If you'd like to contribute to the documentation:

  1. Make your changes or additions following the existing format and style
  2. Use clear, concise language and provide practical examples
  3. Submit a pull request with your changes

Building the Documentation

The documentation uses Mintlify for rendering. The configuration is in the mint.json file.

Documentation TODOs

  • Add more examples and use cases
  • Expand multi-modal capabilities documentation as they are implemented
  • Add more integration guides with other frameworks and services