diff --git a/README.md b/README.md index 46e5299fb..522793d0d 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,13 @@ $ OPENAI_API_KEY="..." python -m redel.server ## Screenshots -TODO +![The ReDel homepage](docs/_static/home.png) + +![Interactive](docs/_static/delegate2.png) + +![Loading saved logs](docs/_static/loader.png) + +![Replay](docs/_static/replay.png) ## Usage diff --git a/docs/_static/busytree.png b/docs/_static/busytree.png new file mode 100644 index 000000000..40bef52c5 Binary files /dev/null and b/docs/_static/busytree.png differ diff --git a/docs/_static/delegate1.png b/docs/_static/delegate1.png new file mode 100644 index 000000000..5bf62176d Binary files /dev/null and b/docs/_static/delegate1.png differ diff --git a/docs/_static/delegate2.png b/docs/_static/delegate2.png new file mode 100644 index 000000000..ae06bd6f1 Binary files /dev/null and b/docs/_static/delegate2.png differ diff --git a/docs/_static/demo1.mov b/docs/_static/demo1.mov new file mode 100644 index 000000000..97f2f33a5 Binary files /dev/null and b/docs/_static/demo1.mov differ diff --git a/docs/_static/demo1.webm b/docs/_static/demo1.webm new file mode 100644 index 000000000..f646f90c5 Binary files /dev/null and b/docs/_static/demo1.webm differ diff --git a/docs/_static/furo_fixes.css b/docs/_static/furo_fixes.css new file mode 100644 index 000000000..bae363808 --- /dev/null +++ b/docs/_static/furo_fixes.css @@ -0,0 +1,3 @@ +video { + max-width: 100%; +} diff --git a/docs/_static/home.png b/docs/_static/home.png new file mode 100644 index 000000000..6f9a6053b Binary files /dev/null and b/docs/_static/home.png differ diff --git a/docs/_static/loader.png b/docs/_static/loader.png new file mode 100644 index 000000000..9d6ef3969 Binary files /dev/null and b/docs/_static/loader.png differ diff --git a/docs/_static/replay.png b/docs/_static/replay.png new file mode 100644 index 000000000..ea17b71e9 Binary files /dev/null and b/docs/_static/replay.png differ diff --git a/docs/conf.py b/docs/conf.py index bfe164a88..69269f980 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,6 +25,7 @@ "sphinx_inline_tabs", # https://sphinx-inline-tabs.readthedocs.io/en/latest/usage.html "sphinx_copybutton", # https://sphinx-copybutton.readthedocs.io/en/latest/ "sphinxemoji.sphinxemoji", # https://sphinxemojicodes.readthedocs.io/en/stable/ + "sphinxcontrib.video", # https://sphinxcontrib-video.readthedocs.io/en/latest/quickstart.html "myst_parser", ] @@ -43,6 +44,10 @@ # html_favicon = "_extra/favicon.ico" html_baseurl = "https://redel.readthedocs.io/en/latest/" +html_css_files = [ + "furo_fixes.css", +] + nitpicky = True nitpick_ignore_regex = [ (r"py:class", r"aiohttp\..*"), # aiohttp intersphinx is borked diff --git a/docs/index.rst b/docs/index.rst index c6c621391..b5be0ad53 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,17 @@ Features built by a big tech organization with their own motives. Everything in ReDel is implemented in pure, idiomatic Python and permissively licensed. +Screenshots +----------- + +.. image:: _static/home.png + +.. image:: _static/delegate2.png + +.. image:: _static/loader.png + +.. image:: _static/replay.png + Quickstart (EMNLP Demo) ----------------------- diff --git a/docs/redel.rst b/docs/redel.rst index 9db97660c..d870f9bac 100644 --- a/docs/redel.rst +++ b/docs/redel.rst @@ -6,7 +6,7 @@ ReDel is a toolkit for researchers and developers to build, iterate on, and anal It consists of two main parts: a Python library for building, running, and logging systems, and a web visualizer to view system logs and interact with systems in a sandbox environment. -.. todo some kind of video here +.. video:: _static/demo1.webm What is a recursive multi-agent system? --------------------------------------- @@ -208,6 +208,11 @@ way to provide this is to change ``ReDel`` to ``dict``. # VizServer.serve() makes the web interface available at 127.0.0.1:8000 by default server.serve() +This will allow you to chat with the current configuration and visualize the computation tree: + +.. image:: _static/delegate2.png + :width: 1000 + See :doc:`viz` for more information about the web interface. Programmatic diff --git a/requirements.txt b/requirements.txt index 80790a23c..2cff7aea5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -12,6 +12,7 @@ furo~=2024.5.6 matplotlib>=3.0.0,<4.0.0 # depended on by opengraph myst-parser~=3.0.1 sphinx~=7.4.5 +sphinxcontrib-video~=0.2.1 sphinxemoji~=0.3.1 sphinx-copybutton~=0.5.2 sphinx-inline-tabs~=2023.4.21