-
Notifications
You must be signed in to change notification settings - Fork 425
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
436 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,297 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>Documentation:Agentverse</title> | ||
| <link type="text/css" rel="stylesheet" href="style.css" /> | ||
| </head> | ||
| <body zoom="65%"> | ||
| <button id="toggle-sidebar-button" ></button> | ||
| <nav id="navbar"> | ||
| <header>AgentVerse <br>Documentation</header> | ||
| <ul> | ||
| <li><a href="#Introduction" class="nav-link">Introduction</a></li> | ||
| <li> | ||
| <a href="#Requirements" class="nav-link" | ||
| >Requirements</a | ||
| > | ||
| </li> | ||
| <li> | ||
| <a href="#Installation" class="nav-link">Installation</a> | ||
| </li> | ||
| <li><a href="#Simulations" class="nav-link"><u>Simulations: GUI</u> </a></li> | ||
| <li> | ||
| <a href="#Gui_Prisoners" class="nav-link">1. Prisoner's dilema</a> | ||
| </li> | ||
| <li><a href="#Gui_classroom" class="nav-link">2. NLP Classroom players</a></li> | ||
|
|
||
| <li><a href="#Gui_sd" class="nav-link">3. Software Design</a></li> | ||
| <li> | ||
|
|
||
| <a href="#cli" class="nav-link"><u>Simulations: CLI</u></a> | ||
| </li> | ||
| <li><a href="#Constants" class="nav-link">1. Prisoner's dilema</a></li> | ||
| <li><a href="#Data_Types" class="nav-link">2. NLP Classroom players</a></li> | ||
| <li> | ||
| <a href="#if...else_Statement" class="nav-link"><u>Task solving: CLI</u></a> | ||
| </li> | ||
| <li><a href="#while_Statement" class="nav-link">1. Brainstorming | ||
| </a></li> | ||
| <li> | ||
| <a href="#Function_Declarations" class="nav-link" | ||
| >2. 24 points</a | ||
| > | ||
| </li> | ||
| <li><a href="#Reference" class="nav-link">3. Task 3</a></li> | ||
| <li><a href="#Reference1" class="nav-link"><u>Task solving: GUI</u> </a></li> | ||
| <li><a href="#Contributing" class="nav-link">Contributing</a></li> | ||
| </ul> | ||
| </nav> | ||
| <main id="main-doc"> | ||
| <section class="main-section" id="Introduction"> | ||
| <article> | ||
| <img src="../imgs/agentverse"> | ||
| <h2>Introduction: AgentVerse</h2> | ||
| <p> | ||
| 🤖 AgentVerse 🪐 <br> | ||
| Think of it as a universe for LLM agents. | ||
| </br>It is designed to facilitate the deployment of multiple LLM-based agents in various applications, which primarily provides two frameworks: task-solving and simulation | ||
| Introduce how to run an example successfully in CLI mode and in GUI mode | ||
| </p> | ||
| <p> | ||
| This project came as a result of ..... | ||
| </p> | ||
| <ul> | ||
| <li> | ||
| The goals of the project are.... | ||
| </li> | ||
| <li> | ||
| Some of the successes that this project has had include .... | ||
| </li> | ||
| </ul> | ||
| </article> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Requirements"> | ||
| <h2>Requirements</h2> | ||
| <article> | ||
| <p>This documentation assumes you have the following:</p> | ||
| <ul> | ||
| <li> AgentVerse <a href="https://github.com/OpenBMB/AgentVerse" target="blank">github repo</a> </li> | ||
| <li> A Python virtual environment setup</li> | ||
| <li> | ||
| A working OpenAI API key | ||
| </li> | ||
| <li>Good working knowledge of Python</li> | ||
| <li> | ||
| Some experience of web development | ||
| </li> | ||
| <li> | ||
| Knowledge and understanding of yaml | ||
| </li> | ||
| <li> | ||
| Interest or a general understanding of LLM's | ||
| </li> | ||
| <li> | ||
| Knoweldge of github | ||
| </li> | ||
| </ul> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </article> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Installation"> | ||
| <h2>Installation</h2> | ||
| <article> | ||
| <a href="https://github.com/OpenBMB/AgentVerse#installation" target="blank">This section</a> of the README has details on how you can get up and running with installing this project. The steps below were used to install it on Windows 10: | ||
| <ul> | ||
| <li> Clone the AgentVerese github repo | ||
| <code></code> | ||
| </li> | ||
|
|
||
| <li> | ||
| <code></code> | ||
| </li> | ||
|
|
||
| <li> | ||
| <code></code> | ||
| </li> | ||
|
|
||
| <li> | ||
| <code></code> | ||
| </li> | ||
| </ul> | ||
| </article> | ||
| <img src="../imgs/docs/environmentKeys.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <br> | ||
| <hr> | ||
| <br> | ||
|
|
||
| <section class="main-section" id="Simulations"> | ||
| <h1><u>Simulations: Graphical User Interface (GUI)</u></h1> | ||
| <article> | ||
| <p> | ||
|
|
||
| </p> | ||
|
|
||
| <p> | ||
| TO add... | ||
| </p> | ||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
|
|
||
| <section class="main-section" id="Gui_Prisoners"> | ||
| <h2>1. Prisoner's dilema</h2> | ||
| <article> | ||
|
|
||
|
|
||
| <p> | ||
| TO add... | ||
| </p> | ||
|
|
||
| <code> | ||
|
|
||
| </code> | ||
| <p> | ||
|
|
||
| </p> | ||
|
|
||
|
|
||
| <p> | ||
|
|
||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Gui_classroom"> | ||
| <h2>2. Natural Language Processing : Classroom players</h2> | ||
| <article> | ||
|
|
||
| <p> | ||
|
|
||
| </p> | ||
| <code> | ||
|
|
||
| </code> | ||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Gui_sd"> | ||
| <h2> 3. Software Design</h2> | ||
| <article> | ||
|
|
||
| </article> | ||
|
|
||
| <br> | ||
| <hr> | ||
| <br> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="cli"> | ||
| <h2><u>Simulations: Command Line Interface</u></h2> | ||
| <article> | ||
|
|
||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Constants"> | ||
| <h2>Prisoner's dilema CLI | ||
| </h2> | ||
| <article> | ||
|
|
||
| <p> | ||
|
|
||
| </p> | ||
|
|
||
| <p> | ||
|
|
||
| </p> | ||
| <code> | ||
|
|
||
| </code> | ||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Data_Types"> | ||
| <h2> Natural Language Processing Classroom players</h2> | ||
| <article> | ||
|
|
||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="#"> | ||
| <h2></h2> | ||
| <article> | ||
| <p> | ||
|
|
||
| </p> | ||
|
|
||
|
|
||
| <p> | ||
|
|
||
| </p> | ||
|
|
||
| <p> | ||
|
|
||
| </p> | ||
|
|
||
|
|
||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="while_Statement"> | ||
| <header>while Statement</header> | ||
| <article> | ||
|
|
||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Function_Declarations"> | ||
| <header>Function Declarations</header> | ||
| <article> | ||
|
|
||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Reference"> | ||
| <h2>Another Task</h2> | ||
| <article> | ||
|
|
||
|
|
||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <section class="main-section" id="Reference1"> | ||
| <h2>Task solving: Graphical User Interface</h2> | ||
| <article> | ||
| > | ||
| </ul> | ||
| </article> | ||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
|
|
||
| <br> | ||
| <hr> | ||
| <br> | ||
| <section class="main-section" id="Contributing"> | ||
| <h2>Contributing</h2> | ||
|
|
||
| <img src="../imgs/docs/Python-virtual-env.png" width="65%" height="50%"> | ||
| </section> | ||
| </main> | ||
| <script> | ||
| </script> | ||
| </html> |
Oops, something went wrong.