* Better documentation of the API

protectai · Feb 14, 2024 · 5d229ac · 5d229ac
1 parent 068f212
commit 5d229ac
Show file tree

Hide file tree

Showing 24 changed files with 205 additions and 68 deletions.
diff --git a/docs/usage/best_practices.md → docs/get_started/best_practices.md b/docs/usage/best_practices.md → docs/get_started/best_practices.md
diff --git a/docs/usage/optimization.md → docs/get_started/optimization.md b/docs/usage/optimization.md → docs/get_started/optimization.md
diff --git a/docs/get_started/playground.md b/docs/get_started/playground.md
@@ -0,0 +1,5 @@
+# Playground of LLM Guard
+
+A live version can be found here: [llm-guard-playground](https://huggingface.co/spaces/ProtectAI/llm-guard-playground).
+
+<iframe src="https://protectai-llm-guard-playground.hf.space" frameborder="0" width="850" height="450"></iframe>
diff --git a/docs/input_scanners/anonymize.md b/docs/input_scanners/anonymize.md
@@ -105,7 +105,7 @@ scanner.
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/input_scanners/ban_topics.md b/docs/input_scanners/ban_topics.md
@@ -34,7 +34,7 @@ sanitized_prompt, is_valid, risk_score = scanner.scan(prompt)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/input_scanners/code.md b/docs/input_scanners/code.md
@@ -57,7 +57,7 @@ sanitized_prompt, is_valid, risk_score = scanner.scan(prompt)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/input_scanners/language.md b/docs/input_scanners/language.md
@@ -42,7 +42,7 @@ sanitized_prompt, is_valid, risk_score = scanner.scan(prompt)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/input_scanners/prompt_injection.md b/docs/input_scanners/prompt_injection.md
@@ -58,7 +58,7 @@ sanitized_prompt, is_valid, risk_score = scanner.scan(prompt)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/input_scanners/toxicity.md b/docs/input_scanners/toxicity.md
@@ -34,7 +34,7 @@ sanitized_prompt, is_valid, risk_score = scanner.scan(prompt)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/ban_topics.md b/docs/output_scanners/ban_topics.md
@@ -31,7 +31,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/bias.md b/docs/output_scanners/bias.md
@@ -33,7 +33,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/code.md b/docs/output_scanners/code.md
@@ -55,7 +55,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/factual_consistency.md b/docs/output_scanners/factual_consistency.md
@@ -34,7 +34,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/language.md b/docs/output_scanners/language.md
@@ -37,7 +37,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/language_same.md b/docs/output_scanners/language_same.md
@@ -39,7 +39,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/malicious_urls.md b/docs/output_scanners/malicious_urls.md
@@ -29,7 +29,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/no_refusal.md b/docs/output_scanners/no_refusal.md
@@ -33,7 +33,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/relevance.md b/docs/output_scanners/relevance.md
@@ -33,7 +33,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/sensitive.md b/docs/output_scanners/sensitive.md
@@ -45,7 +45,7 @@ The `redact` feature, when enabled, ensures sensitive entities are seamlessly re
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks
 

diff --git a/docs/output_scanners/toxicity.md b/docs/output_scanners/toxicity.md
@@ -34,7 +34,7 @@ sanitized_output, is_valid, risk_score = scanner.scan(prompt, model_output)
 
 ## Optimization Strategies
 
-[Read more](../usage/optimization.md)
+[Read more](../get_started/optimization.md)
 
 ## Benchmarks