Skip to content

MadsRC/sophrosyne

Repository files navigation

Sophrosyne

Quality Gate Status Bugs Code Smells Coverage Duplicated Lines (%) Lines of Code Reliability Rating Security Rating Technical Debt Maintainability Rating Vulnerabilities OpenSSF Scorecard OpenSSF Best Practices CodeQL Semgrep

Sophrosyne is a horizontally scaleable content moderation API built for the age of Generative AI.

The API allows you to register upstream modules to perform artibrary checks on input data and return a go/no-go verdict. Checks are associated with profiles, allowing several checks to be run on a piece of input data.

The application provides the API, but does not include any checks. Checks are expected to be implemented as self-contained services communicating with sophrosyne via gRPC. Reference implementations and documentation for how these services should function will be provided.

Stability

This project follows semantic versioning, and will introduce breaking changes several times before reaching version 1.0.0.

Usage

Sophrosyne is intended to be used in a container, although binaries are available for each release.

Container images are hosted in ghcr.io and can be located here.

The container repository in question is ghcr.io/madsrc/sophrosyne.

Sophrosyne is released for linux on the amd64 and arm64 platform.

A container can be run by running the following command: docker run ghcr.io/madsrc/sophrosyne:0.0.2.