add: docs for regex model

docs/metrics.md

@@ -0,0 +1,3 @@
+# Metrics
+
+::: guardrails_genie.metrics

docs/regex_model.md

@@ -0,0 +1,11 @@
+# RegexModel
+
+!!! example "Sample Pattern"
+    ```python
+    {
+        "email": r"[^@ \t\r\n]+@[^@ \t\r\n]+\.[^@ \t\r\n]+",
+        "phone": r"\b\d{3}[-.]?\d{3}[-.]?\d{4}\b"
+    }
+    ```
+
+::: guardrails_genie.regex_model

guardrails_genie/regex_model.py

@@ -12,17 +12,16 @@ class RegexResult(BaseModel):
 
 
 class RegexModel(weave.Model):
+    """
+    Initialize RegexModel with a dictionary of patterns.
+
+    Args:
+        patterns (Dict[str, str]): Dictionary where key is pattern name and value is regex pattern.
+    """
+
     patterns: Dict[str, str]
 
     def __init__(self, patterns: Dict[str, str]) -> None:
-        """
-        Initialize RegexModel with a dictionary of patterns.
-
-        Args:
-            patterns: Dictionary where key is pattern name and value is regex pattern
-                     Example: {"email": r"[^@ \t\r\n]+@[^@ \t\r\n]+\.[^@ \t\r\n]+",
-                              "phone": r"\b\d{3}[-.]?\d{3}[-.]?\d{4}\b"}
-        """
         super().__init__(patterns=patterns)
         self._compiled_patterns = {
             name: re.compile(pattern) for name, pattern in patterns.items()

mkdocs.yml

@@ -59,6 +59,8 @@ extra_javascript:
 
 nav:
   - Home: 'index.md'
+  - Metrics: 'metrics.md'
+  - RegexModel: 'regex_model.md'
   - Utils: 'utils.md'
 
 repo_url: https://github.com/soumik12345/guardrails-genie