Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AMK9978 authored Nov 24, 2024
1 parent b3aefc3 commit bfeed27
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# LLM Guardian Central Unit
# LLM Guardian Kernel
A plug-and-play end-to-end LLM guardian for seamless integration.
The central unit is in charge of fanning out requests to the connected
security plugins based on user, and collecting their responses to judge whether a prompt
is malicious or benign. You can also use the central unit as a rate limiter, authentication unit, or quota management.
The kernel is in charge of fanning out requests to the connected
security plugins based on user and collecting their responses to judge whether a prompt
is malicious or benign. You can also use the kernel as a rate limiter, authentication unit, or quota management.

## Features & Qualities
- Written in Golang to be super-fast and production-ready
- Microkernel architecture: Open to extension
- Rate limiter
- Supports both HTTP/1.1 and gRPC plugins with reusable gPRC clients
- Define tasks and apply them to users/groups
- SOLID obedient and Database agnostic (MongoDB by default)
- Test covered, CI, linter


## Get Started
Expand All @@ -18,6 +27,9 @@ The guardian system uses a micro-kernel architecture designed by the idea of ext
![Architecture](./docs/arch.jpg)


## Citation
If you use this application, please cite it using the "Cite this repository" above.

## Contribution
I am always welcome to your contributions. Open an issue and/or open a PR accordingly.
This system is designed and the central unit is developed by Amir Karimi (@amk9978).
Expand Down

0 comments on commit bfeed27

Please sign in to comment.