Skip to content

Commit

Permalink
feat(docs): Add metrics documentation and update styles
Browse files Browse the repository at this point in the history
- 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)
  • Loading branch information
BillChirico committed Nov 8, 2023
1 parent 29eeb8d commit d5aeb6e
Show file tree
Hide file tree
Showing 4 changed files with 128 additions and 11 deletions.
12 changes: 12 additions & 0 deletions docs/basics/metrics.mdx
Original file line number Diff line number Diff line change
@@ -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.
118 changes: 111 additions & 7 deletions docs/basics/models-and-metrics.mdx → docs/basics/models.mdx
Original file line number Diff line number Diff line change
@@ -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?

Expand All @@ -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).
5 changes: 3 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,9 @@ const config: Config = {
by <a href="https://github.com/VolvoxLLC">Volvox</a></span><br /><br />Copyright © ${new Date().getFullYear()} Volvox LLC`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
theme: prismThemes.oneLight,
darkTheme: prismThemes.oneDark,
additionalLanguages: ['json']
},
} satisfies Preset.ThemeConfig,

Expand Down
4 changes: 2 additions & 2 deletions src/css/custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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. */
Expand Down

0 comments on commit d5aeb6e

Please sign in to comment.