Merge pull request #94 from RomiconEZ/main-2-3-0

Release v2.3.0 and Release v2.3.1

Author: RomiconEZ

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.2.0
+current_version = 2.3.1
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?

README.md

@@ -13,13 +13,18 @@ Red Teaming python-framework for testing chatbots and LLM systems
 ## Install 🚀
 
 ```bash
-pip install llamator==2.2.0
+pip install llamator==2.3.1
 ```
 
 ## Documentation 📚
 
 Documentation Link: [https://romiconez.github.io/llamator](https://romiconez.github.io/llamator/)
 
+## Guides ▶️
+
+* [LLM Red Teaming with LLAMATOR](https://www.youtube.com/watch?v=JGTZMJsgZJU)
+* [LLAMATOR: Quick Start Guide](https://www.youtube.com/watch?v=MMez57DsO1k)
+
 ## Examples 💡
 
 * 📄 [RAG bot testing via REST API](https://github.com/RomiconEZ/llamator/blob/release/examples/llamator-api.ipynb)

assets/LL.svg

@@ -183,7 +183,7 @@ The `multistage_depth` parameter for using in `history_limit` can be extracted f
 ```
 </details>
 
-### OWASP [LLM01:2025](https://genai.owasp.org/llmrisk/llm01-prompt-injection/) Prompt Injection
+### OWASP [LLM01:2025](https://genai.owasp.org/llmrisk/llm01-prompt-injection/) Continuous Prompt Injection
 
 <details>
 <summary><strong>Crescendo</strong></summary>
@@ -241,4 +241,4 @@ Attacks the LLM system during a multistage conversation using the argumentum ad
 _Original Paper <https://arxiv.org/abs/2310.13548>_
 
 <a href="https://github.com/RomiconEZ/llamator/blob/release/src/llamator/attacks/sycophancy.py">View code on GitHub</a>
-</details>
+</details>

assets/LLAMATOR.svg

@@ -4,22 +4,18 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
 project = 'LLAMATOR'
-copyright = '2024, LLaMasters'
-author = 'Neronov Roman, Nizamov Timur, Fazlyev Albert, Ivanov Nikita, Iogan Maksim'
+copyright = '2025, Neronov Roman, Nizamov Timur, Ivanov Nikita'
+author = 'Neronov Roman, Nizamov Timur, Ivanov Nikita'
 
 # -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
 extensions = [
-    "sphinx.ext.napoleon",# support for google style docstrings
-    "sphinx.ext.autodoc", # auto* are for automatic code docs generation
-    "sphinx.ext.autosummary", # as above
-    "sphinx.ext.intersphinx", # allows to cross reference other sphinx documentations
+    "sphinx.ext.napoleon",         # support for google style docstrings
+    "sphinx.ext.autodoc",          # auto* are for automatic code docs generation
+    "sphinx.ext.autosummary",      # as above
+    "sphinx.ext.intersphinx",      # allows to cross reference other sphinx documentations
     "sphinx.ext.autosectionlabel", # each doc section gets automatic reference generated
-    "myst_parser", # adds support for Markdown
+    "myst_parser",                 # adds support for Markdown
     "sphinx.ext.extlinks",
     "sphinx.ext.mathjax",
     "sphinx.ext.todo",
@@ -30,58 +26,46 @@
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # -- Options for TODOs -------------------------------------------------------
-#
-
 todo_include_todos = False
 
 # -- Options for Markdown files ----------------------------------------------
-#
-
 myst_enable_extensions = [
     "colon_fence",
     "deflist",
 ]
 myst_heading_anchors = 3
 
 # -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
 html_theme = "furo"
 html_static_path = ["_static"]
-# Set link name generated in the top bar.
+
+html_logo = "../assets/LLAMATOR.svg"
+
 html_title = "LLAMATOR"
 
 html_theme_options = {
     "light_css_variables": {
-        # Primary background colors
         "color-background-primary": "#f8f5fa",  # Very light pinkish purple background
         "color-background-secondary": "#f0ebf3",  # Slightly darker pinkish purple
-        # Text colors
         "color-foreground-primary": "#2d1b36",  # Very dark purple for primary text
         "color-foreground-secondary": "#432952",  # Dark purple for secondary text
-        # Brand colors
         "color-brand-primary": "#2d1b36",  # Very dark purple
         "color-brand-content": "#432952",  # Dark purple
-        # Links
         "color-link": "#614378",  # Purple for links
         "color-link-hover": "#7b5696",  # Lighter purple on hover
-        # Admonitions
         "color-admonition-background": "#fff9fc",  # Very light pink background for notes
         "color-admonition-title-background": "#2d1b36",  # Very dark purple for the title
         "color-admonition-title": "#ffffff",  # White text on dark background
         "color-admonition-border": "#2d1b36",  # Very dark purple for the border
-        # Code
         "color-code-background": "#f5f0f7",  # Light pinkish purple background for code
         "color-code-foreground": "#2d1b36",  # Very dark purple code text
-        # Sidebar
         "color-sidebar-background": "#f5f0f7",  # Light pinkish purple sidebar background
         "color-sidebar-item-background--hover": "#ebe4ef",  # On menu item hover
         "color-sidebar-item-expander-background--hover": "#e0d7e6",  # On hover over a drop-down element
         "color-sidebar-search-background": "#fff9fc",  # Very light pink search background
         "color-sidebar-search-background--focus": "#fff9fc",  # Same on focus
     },
     "dark_css_variables": {
-        # [Leave the dark theme unchanged]
         "color-background-primary": "#1a1b24",
         "color-background-secondary": "#44475a",
         "color-foreground-primary": "#f8f8f2",
@@ -102,8 +86,7 @@
         "color-sidebar-search-background": "#44475a",
         "color-sidebar-search-background--focus": "#44475a",
     },
-    # [The rest of the settings remain unchanged.]
-    "sidebar_hide_name": False,
+    "sidebar_hide_name": True,
     "footer_icons": [
         {
             "name": "GitHub",
@@ -123,14 +106,12 @@
 
 autosectionlabel_prefix_document = True
 
-# Mapping to link other documentations
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
     "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
     "numpy": ("https://numpy.org/doc/stable", None),
 }
 
-
 # Configuration for Napoleon extension
 napoleon_google_docstring = True
 napoleon_numpy_docstring = True
@@ -157,11 +138,4 @@
 }
 
 pygments_style = "dracula"
-pygments_dark_style = "dracula"
-
-# workaround for sphinx material issue with empty left sidebar
-# See: https://github.com/bashtage/sphinx-material/issues/30
-# uncomment below lines if you use: html_theme = "sphinx_material"
-# html_sidebars = {
-#    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
-# }
+pygments_dark_style = "dracula"

docs/attack_descriptions.md

@@ -0,0 +1,17 @@
+Guides
+======
+
+This section contains YouTube video tutorials providing detailed guides on using LLAMATOR.
+
+.. raw:: html
+
+    <div style="display: flex; flex-wrap: wrap; gap: 20px;">
+      <div style="flex: 1 1 45%; min-width: 300px;">
+        <h3 style="font-size: 20px;">LLM Red Teaming with LLAMATOR</h3>
+        <iframe width="100%" height="315" src="https://www.youtube.com/embed/JGTZMJsgZJU" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+      </div>
+      <div style="flex: 1 1 45%; min-width: 300px;">
+        <h3 style="font-size: 20px;">LLAMATOR: Quick Start Guide</h3>
+        <iframe width="100%" height="315" src="https://www.youtube.com/embed/MMez57DsO1k" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+      </div>
+    </div>

docs/conf.py

@@ -12,7 +12,7 @@
 ## Installation Guide
 
 ```bash
-pip install llamator==2.2.0
+pip install llamator==2.3.1
 ```
 
 ## Usage Guide (using LM Studio)

docs/guides.rst

@@ -2,9 +2,11 @@
    You can adapt this file completely to your preferences, but it should at least
    contain the root `toctree` directive.
 
-===============================
-           LLAMATOR
-===============================
+.. |LLM_SECURITY_TOOLitalic| replace:: *LLM Security Tool*
+
+===================================
+          |LLM_SECURITY_TOOLitalic|
+===================================
 
 .. |LLAMATOR| replace:: **llamator**
 .. _LLAMATOR: https://pypi.org/project/llamator/
@@ -17,6 +19,7 @@ Documentation for |LLAMATOR|_ python package.
 
    project_overview
    howtos
+   guides
    attack_descriptions
    code_documentation
-   licenses
+   licenses

docs/howtos.md

@@ -1,5 +1,5 @@
 """Version information."""
 
 # fmt: off
-__version__ = '2.2.0'  # noqa
+__version__ = '2.3.1'  # noqa
 # fmt: on