Update README.md
Browse files
README.md
CHANGED
|
@@ -1,32 +1,27 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
This model is a fine-tuned version of `Qwen3ForGuardModel` designed for safety moderation, specifically tailored for PowerShell content.
|
| 18 |
|
| 19 |
## Model Details
|
| 20 |
|
| 21 |
- **Model Type**: Qwen3 Guard Stream
|
| 22 |
- **Architecture**: `Qwen3ForGuardModel`
|
| 23 |
-
- **Language**: Multilingual (119 languages), specialized for PowerShell
|
| 24 |
- **License**: Apache 2.0
|
| 25 |
|
| 26 |
## Training Information
|
| 27 |
|
| 28 |
-
The model was fine-tuned with the following parameters:
|
| 29 |
-
|
| 30 |
- **Epochs**: ~1.55
|
| 31 |
- **Global Steps**: 2500
|
| 32 |
- **Best Loss**: 0.0777 (at step 1800)
|
|
@@ -36,9 +31,6 @@ The model was fine-tuned with the following parameters:
|
|
| 36 |
- **F1 Safe**: 98.66%
|
| 37 |
- **F1 Unsafe**: 97.91%
|
| 38 |
|
| 39 |
-
## Usage
|
| 40 |
-
|
| 41 |
-
This model is designed to be used with the `transformers` library for real-time safety moderation.
|
| 42 |
|
| 43 |
### Example Code
|
| 44 |
|
|
|
|
| 1 |
+
|
| 2 |
+
# Codeguard-Stream for PowerShell
|
| 3 |
+
|
| 4 |
+
Codeguard is a model family based on the Qwen3Guard (primarily stream) models.
|
| 5 |
+
This model is the first variant of a series of models and serves as a proof of concept.
|
| 6 |
+
|
| 7 |
+
Motivation: As the usage of language models for code generation is increasing, and specifically agentic code generation softwarem we need to ensure that the code that is generated is safe to execute.
|
| 8 |
+
In theory, one should never allow a language model to execute code that could in any way be malicious.
|
| 9 |
+
But in practice, people sacrifice their security for the sake of efficiency, exposing themselves to immense risk if a malicious string of code is executed.
|
| 10 |
+
The code guard models is an effort to add another layer of security on top of code agents so that if malicious code or vulnerable code is detected
|
| 11 |
+
the generation is immediately interrupted to prevent execution of said code.
|
| 12 |
+
|
| 13 |
+
We do not recommend to use this model as a replacement of common sense OPSEC.
|
| 14 |
+
But we believe that this is an important step of research to arrive at a technical setup that can maximize efficiency while minimizing the risk of harm.
|
| 15 |
+
|
|
|
|
|
|
|
| 16 |
|
| 17 |
## Model Details
|
| 18 |
|
| 19 |
- **Model Type**: Qwen3 Guard Stream
|
| 20 |
- **Architecture**: `Qwen3ForGuardModel`
|
|
|
|
| 21 |
- **License**: Apache 2.0
|
| 22 |
|
| 23 |
## Training Information
|
| 24 |
|
|
|
|
|
|
|
| 25 |
- **Epochs**: ~1.55
|
| 26 |
- **Global Steps**: 2500
|
| 27 |
- **Best Loss**: 0.0777 (at step 1800)
|
|
|
|
| 31 |
- **F1 Safe**: 98.66%
|
| 32 |
- **F1 Unsafe**: 97.91%
|
| 33 |
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
### Example Code
|
| 36 |
|