From d5aeb6e832a2dd0c085588e3cd055690a66cf629 Mon Sep 17 00:00:00 2001 From: Bill Chirico Date: Wed, 8 Nov 2023 15:43:47 -0500 Subject: [PATCH] feat(docs): Add metrics documentation and update styles - Added a new file `metrics.mdx` to document the available Volvox.Apollo Metrics. - Renamed the file `models-and-metrics.mdx` to `models.mdx`. - Updated the content in `models.mdx` to focus only on Volvox.Apollo Models. - Added example responses for different inputs in the models documentation. - Included a demo link for users to try out different inputs and view model metrics. - Updated the Docusaurus configuration file (`docusaurus.config.ts`) to use the One Light theme for code highlighting and added support for JSON syntax highlighting. - Updated custom styles (`custom.scss`) to import the Rubik font from Google Fonts. Demo: [https://apollo.volvox.tech](https://apollo.volvox.tech) --- docs/basics/metrics.mdx | 12 ++ .../{models-and-metrics.mdx => models.mdx} | 118 ++++++++++++++++-- docusaurus.config.ts | 5 +- src/css/custom.scss | 4 +- 4 files changed, 128 insertions(+), 11 deletions(-) create mode 100644 docs/basics/metrics.mdx rename docs/basics/{models-and-metrics.mdx => models.mdx} (66%) diff --git a/docs/basics/metrics.mdx b/docs/basics/metrics.mdx new file mode 100644 index 0000000..65a2add --- /dev/null +++ b/docs/basics/metrics.mdx @@ -0,0 +1,12 @@ +--- +sidebar_position: 1 +title: Metrics +description: Available Volvox.Apollo Metrics +slug: /metrics +--- + +# Metrics + +The Analyze API endpoint in the Volvox.Apollo suite processes the input to yield a collection of models, each accompanied by a score that quantifies its relevance. +Scores span from 0 to 100, where a score of 100 signifies an exact match with the ideal model profile. +This scoring system facilitates users in identifying the most suitable model by providing a clear, numerical measure of compatibility. \ No newline at end of file diff --git a/docs/basics/models-and-metrics.mdx b/docs/basics/models.mdx similarity index 66% rename from docs/basics/models-and-metrics.mdx rename to docs/basics/models.mdx index c193573..e2199cb 100644 --- a/docs/basics/models-and-metrics.mdx +++ b/docs/basics/models.mdx @@ -1,13 +1,12 @@ --- -sidebar_position: 1 -title: Models & Metrics -description: Available Volvox.Apollo Models & Metrics -slug: /models-metrics +sidebar_position: 2 +title: Models +description: Available Volvox.Apollo Models +slug: /models --- -# Models & Metrics - -The Analyze API endpoint in the Volvox.Apollo suite processes the input to yield a collection of models, each accompanied by a score that quantifies its relevance. Scores span from 0 to 100, where a score of 100 signifies an exact match with the ideal model profile. This scoring system facilitates users in identifying the most suitable model by providing a clear, numerical measure of compatibility. +# Volvox.Apollo Models +Volvox.Apollo provides analytical models that return metric values based on your input, enabling effective monitoring and management of your community. ## What are the Volvox.Apollo Models? @@ -24,3 +23,108 @@ The Analyze API endpoint in the Volvox.Apollo suite processes the input to yield | Inflammatory | Statements or content that are intentionally provocative, offensive, or designed to incite anger, resentment, or conflict in others | | Obscene | Conduct or content that is considered extremely offensive, indecent, or morally repugnant, typically in violation of societal norms | | Spam | Unsolicited, irrelevant or repetitive messages, content, or communications sent in bulk. These messages are typically sent via email, instant messaging, or other digital communication channels | + +## Example Responses + +Input = `This is a test input.` +```json +[ + { + "model": "Toxicity", + "score": 1.23 + }, + { + "model": "SevereToxicity", + "score": 0.11 + }, + { + "model": "IdentityAttack", + "score": 0.26 + }, + { + "model": "Insult", + "score": 0.76 + }, + { + "model": "Profanity", + "score": 1.41 + }, + { + "model": "Threat", + "score": 0.74 + }, + { + "model": "SexuallyExplicit", + "score": 1.05 + }, + { + "model": "Flirtation", + "score": 17.25 + }, + { + "model": "Inflammatory", + "score": 5.66 + }, + { + "model": "Obscene", + "score": 3.43 + }, + { + "model": "Spam", + "score": 10.01 + } +] +``` + +Input = `I want to light your house on fire.` +```json +[ + { + "model": "Toxicity", + "score": 71.76 + }, + { + "model": "SevereToxicity", + "score": 35.37 + }, + { + "model": "IdentityAttack", + "score": 12.44 + }, + { + "model": "Insult", + "score": 24.93 + }, + { + "model": "Profanity", + "score": 26.58 + }, + { + "model": "Threat", + "score": 70.48 + }, + { + "model": "SexuallyExplicit", + "score": 2.37 + }, + { + "model": "Flirtation", + "score": 35.55 + }, + { + "model": "Inflammatory", + "score": 14.63 + }, + { + "model": "Obscene", + "score": 1.87 + }, + { + "model": "Spam", + "score": 4.57 + } +] +``` + +### Demo +You can demo any inputs and see the list of models with thier corrosponding metrics [here](https://apollo.volvox.tech). \ No newline at end of file diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 5104023..ada8143 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -135,8 +135,9 @@ const config: Config = { by Volvox

Copyright © ${new Date().getFullYear()} Volvox LLC`, }, prism: { - theme: prismThemes.github, - darkTheme: prismThemes.dracula, + theme: prismThemes.oneLight, + darkTheme: prismThemes.oneDark, + additionalLanguages: ['json'] }, } satisfies Preset.ThemeConfig, diff --git a/src/css/custom.scss b/src/css/custom.scss index 63e3c1d..a3a63ba 100644 --- a/src/css/custom.scss +++ b/src/css/custom.scss @@ -4,7 +4,7 @@ * work well for content-centric websites. */ - @import url('https://fonts.googleapis.com/css2?family=JetBrains+Mono&display=swap'); + @import url('https://fonts.googleapis.com/css2?family=Rubik&display=swap'); /* You can override the default Infima variables here. */ :root { @@ -17,7 +17,7 @@ --ifm-color-primary-lightest: #6BB1FF; --ifm-code-font-size: 95%; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); - --ifm-font-family-base: 'JetBrains Mono'; + --ifm-font-family-base: 'Rubik'; } /* For readability concerns, you should choose a lighter palette in dark mode. */