updated readme and docs

README.md

@@ -10,7 +10,7 @@ Plexiglass</h1>
 
 ## What is Plexiglass?
 
-Plexiglass is a toolbox designed to test vulnerabilities and safeguard LLMs.
+Plexiglass is a toolkit for detecting and protecting against vulnerabilities in Large Language Models (LLMs).
 
 Plexiglass uses [litellm](https://github.com/BerriAI/litellm) under the hood. 
 

docs/Makefile

@@ -1,10 +1,8 @@
 # Minimal makefile for Sphinx documentation
-#
 
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build
 
@@ -17,4 +15,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,36 @@
+## Build the Docs
+
+### Setup (do once)
+
+Install [sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
+for example with `conda`:
+
+```
+conda install sphinx
+pip install sphinx-book-theme
+```
+
+### Build
+
+Build the docs from `mlx/docs/`
+
+```
+make html
+```
+
+View the docs by running a server in `mlx/docs/build/html/`:
+
+```
+python -m http.server <port>
+```
+
+and point your browser to `http://localhost:<port>`.
+
+### Push to Github Pages
+
+Check-out the `gh-pages` branch (`git switch gh-pages`) and build
+the docs. Then force add the `build/html` directory:
+
+`git add -f build/html`
+
+Commit and push the changes to the `gh-pages` branch.

docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: bafbfe128a125bac792a64c580cef9ed
+config: 637347761558919500feb5e6b5efb236
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/index.rst.txt

@@ -1,20 +1,34 @@
-.. plexiglass documentation master file, created by
-   sphinx-quickstart on Sat Dec  9 22:48:04 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+Plexiglass
+==========
 
-Welcome to plexiglass's documentation!
-======================================
+Plexiglass is an innovative toolbox designed to test vulnerabilities and safeguard Language Learning Models (LLMs), developed by Kortex Labs. This Python-based security toolbox operates with a focus on the rigorous testing and enhancement of security measures for LLMs.
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+Key Features
+------------
 
+- **Security-focused LLM Toolbox**: Plexiglass is crafted as a security toolbox specifically for testing and safeguarding LLMs, making it an essential tool for developers working with these models.
 
+- **Versatile Testing Modes**: It offers two primary modes of operation: `llm-chat` and `llm-scan`. The `llm-chat` mode enables interactive conversations with LLMs, allowing the assessment of predefined metrics like toxicity in responses. Meanwhile, the `llm-scan` mode is designed to run tests to identify and evaluate various vulnerabilities within LLMs.
 
-Indices and tables
-==================
+- **Ease of Use**: Users can begin using Plexiglass simply by installing it and running `plx --help` for guidance, emphasizing user-friendliness and accessibility.
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+- **Open-Source and Community-Driven**: Plexiglass is an open-source project, encouraging community contributions and feedback. This collaborative approach ensures continuous improvement and adaptation to emerging security needs in LLMs.
+
+- **First Release and Installation**: The first experimental release of Plexiglass is version `0.0.1`, available for download from PyPi. Users can easily install it using the command `pip install --upgrade plexiglass`.
+
+Inspiration and Compatibility
+------------------------------
+
+- The development of Plexiglass is motivated by the increasing importance of security in machine learning and AI. It aligns with the current trend of creating robust and secure AI systems, especially in the realm of language learning models.
+
+- Plexiglass uses `litellm` under the hood, suggesting compatibility with a range of LLMs and providing a versatile tool for developers and researchers in the field.
+
+Community Involvement
+---------------------
+
+- Kortex Labs emphasizes the importance of community involvement in Plexiglass's development. They are actively seeking contributors to further enrich the toolbox and extend its capabilities.
+
+Documentation and Further Information
+-------------------------------------
+
+- Comprehensive documentation for Plexiglass is available, providing users with detailed information on its features, installation, and usage.

docs/build/html/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -222,7 +222,7 @@ table.modindextable td {
 /* -- general body styles --------------------------------------------------- */
 
 div.body {
-    min-width: 360px;
+    min-width: 450px;
     max-width: 800px;
 }
 
@@ -237,8 +237,14 @@ a.headerlink {
     visibility: hidden;
 }
 
-a:visited {
-    color: #551A8B;
+a.brackets:before,
+span.brackets > a:before{
+    content: "[";
+}
+
+a.brackets:after,
+span.brackets > a:after {
+    content: "]";
 }
 
 h1:hover > a.headerlink,
@@ -329,16 +335,12 @@ p.sidebar-title {
     font-weight: bold;
 }
 
-nav.contents,
-aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
 
-nav.contents,
-aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -377,17 +379,13 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
-nav.contents > :last-child,
-aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
-nav.contents::after,
-aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -430,6 +428,10 @@ table.docutils td, table.docutils th {
     border-bottom: 1px solid #aaa;
 }
 
+table.footnote td, table.footnote th {
+    border: 0 !important;
+}
+
 th {
     text-align: left;
     padding-right: 5px;
@@ -613,26 +615,19 @@ ul.simple p {
     margin-bottom: 0;
 }
 
-aside.footnote > span,
-div.citation > span {
+dl.footnote > dt,
+dl.citation > dt {
     float: left;
+    margin-right: 0.5em;
 }
-aside.footnote > span:last-of-type,
-div.citation > span:last-of-type {
-  padding-right: 0.5em;
-}
-aside.footnote > p {
-  margin-left: 2em;
-}
-div.citation > p {
-  margin-left: 4em;
-}
-aside.footnote > p:last-of-type,
-div.citation > p:last-of-type {
+
+dl.footnote > dd,
+dl.citation > dd {
     margin-bottom: 0em;
 }
-aside.footnote > p:last-of-type:after,
-div.citation > p:last-of-type:after {
+
+dl.footnote > dd:after,
+dl.citation > dd:after {
     content: "";
     clear: both;
 }
@@ -649,6 +644,10 @@ dl.field-list > dt {
     padding-right: 5px;
 }
 
+dl.field-list > dt:after {
+    content: ":";
+}
+
 dl.field-list > dd {
     padding-left: 0.5em;
     margin-top: 0em;
@@ -674,16 +673,6 @@ dd {
     margin-left: 30px;
 }
 
-.sig dd {
-    margin-top: 0px;
-    margin-bottom: 0px;
-}
-
-.sig dl {
-    margin-top: 0px;
-    margin-bottom: 0px;
-}
-
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -752,14 +741,6 @@ abbr, acronym {
     cursor: help;
 }
 
-.translated {
-    background-color: rgba(207, 255, 207, 0.2)
-}
-
-.untranslated {
-    background-color: rgba(255, 207, 207, 0.2)
-}
-
 /* -- code displays --------------------------------------------------------- */
 
 pre {