llnl / llnl/mada

Create a Basic Tutorial for Each Supported Interface

Open
#19 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
2
Forks
2
Avg merge
1d 4h
Merged PRs (30d)
4

Description

Every tutorial here should show how to create a config with two agents that have instructions (model this off the example/helpful config).

For CLI this should show:

1. Start the agent interaction with `mada-cli`
2. Session selection
3. Prompting the agent
4. Quitting the interaction
5. Restarting the interaction with `mada-cli`
6. Selecting the session we just created to show that history is stored
7. [Optional] Updating the database to be PostgreSQL instead of SQLite

For Gradio this should show:

1. Adding Gradio interface configuration to the config file
2. Starting the Gradio interface with `mada-gradio`
3. Opening the Web UI and explaining the different parts of it
4. Initialize the orchestrator
5. Prompt the agents
6. Shut down the Gradio app in the terminal with `ctrl+C`

For OpenAI this should show:

1. Starting the OpenAI API with `mada-openai-api` (should discuss starting with an API key)
2. Opening the WebUI and explaining the different parts of it
3. Prompting the agents
4. Shutting down the OpenAI API in the terminal

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the existing tutorials and the example/helpful config first, then trace how the CLI, Gradio, and OpenAI interfaces are started. Create a tutorial for each interface covering configuration, startup, prompting, shutdown, and the CLI's stored-session flow; include the PostgreSQL option if supported. Done means a newcomer can follow each tutorial end to end.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql, python, sqlite
Domain
cli, databases, documentation, web-dev
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.