From ae295a7acd587f8712ebfe534d117cffb42be80d Mon Sep 17 00:00:00 2001 From: ModelHub XC Date: Tue, 17 Nov 2026 07:34:17 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=9D=E5=A7=8B=E5=8C=96=E9=A1=B9=E7=9B=AE?= =?UTF-8?q?=EF=BC=8C=E7=94=B1ModelHub=20XC=E7=A4=BE=E5=8C=BA=E6=8F=90?= =?UTF-8?q?=E4=BE=9B=E6=A8=A1=E5=9E=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Model: Yunhao-Feng/AdaGuard-4B Source: Original Platform --- .gitattributes | 2 + LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++ NOTICE | 15 +++ README.md | 196 ++++++++++++++++++++++++++++++++++++++ assets/banner.svg | 24 +++++ chat_template.jinja | 9 ++ config.json | 71 ++++++++++++++ evaluation_results.json | 56 +++++++++++ examples/inputs.jsonl | 2 + examples/quickstart.py | 160 +++++++++++++++++++++++++++++++ generation_config.json | 8 ++ model.safetensors | 3 + requirements.txt | 5 + tokenizer.json | 3 + tokenizer_config.json | 30 ++++++ 15 files changed, 786 insertions(+) create mode 100644 .gitattributes create mode 100644 LICENSE create mode 100644 NOTICE create mode 100644 README.md create mode 100644 assets/banner.svg create mode 100644 chat_template.jinja create mode 100644 config.json create mode 100644 evaluation_results.json create mode 100644 examples/inputs.jsonl create mode 100644 examples/quickstart.py create mode 100644 generation_config.json create mode 100644 model.safetensors create mode 100644 requirements.txt create mode 100644 tokenizer.json create mode 100644 tokenizer_config.json diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..0fd17d2 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +*.safetensors filter=lfs diff=lfs merge=lfs -text +tokenizer.json filter=lfs diff=lfs merge=lfs -text diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6634c8c --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Alibaba Cloud + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..f71bbee --- /dev/null +++ b/NOTICE @@ -0,0 +1,15 @@ +AdaGuard-4B +Copyright 2026 AdaGuard contributors + +Based on Qwen/Qwen3Guard-Gen-4B. +Upstream license notice: Copyright 2024 Alibaba Cloud. +https://huggingface.co/Qwen/Qwen3Guard-Gen-4B + +AdaGuard modifications: supervised fine-tuning for user-defined policies, +SafePO training, policy-conditioned ChatML prompting, and inference examples. +The release retains the trained checkpoint values without precision conversion. +Inference configuration enables caching, removes a fixed attention backend, +aligns tokenizer limits with the model, and sets explicit generation limits. + +The upstream Apache License is reproduced in LICENSE. The new example code +and documentation are distributed under Apache-2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..96de589 --- /dev/null +++ b/README.md @@ -0,0 +1,196 @@ +--- +license: apache-2.0 +library_name: transformers +pipeline_tag: text-generation +base_model: Qwen/Qwen3Guard-Gen-4B +base_model_relation: finetune +tags: + - qwen3 + - safetensors + - safety + - guard-model + - policy-conditioned + - agent-safety + - reinforcement-learning +--- + +![AdaGuard-4B: policy and interaction to analysis and violated rule IDs](assets/banner.svg) + +# AdaGuard-4B + +**Your policies. Clear explanations. Rule-level verdicts.** + +AdaGuard evaluates user requests and agent trajectories against policies you define. It generates a policy-grounded analysis and identifies the specific rules violated, rather than requiring a fixed risk taxonomy. + +[GitHub](https://github.com/Yunhao-Feng/AdaGuard) · [Apache-2.0](LICENSE) · [Runnable example](examples/quickstart.py) · [Evaluation data](evaluation_results.json) + +**Model family:** [**0.6B**](https://huggingface.co/Yunhao-Feng/AdaGuard-0.6B) · [**4B**](https://huggingface.co/Yunhao-Feng/AdaGuard-4B) · [**8B**](https://huggingface.co/Yunhao-Feng/AdaGuard-8B) + +## What you can do + +- **Bring your own policy.** Supply 1–100 rules with identifiers local to your application. +- **Assess requests or agent behavior.** Evaluate a user-only request, or a sequence of agent actions and tool results. +- **Get actionable rule IDs.** Receive an analysis plus the violated IDs in policy order, or `NR` when no supplied rule is violated. + +The generated verdict is a structured decision, **not a calibrated risk probability**. + +| Choose | Good starting point for | +|---|---| +| [0.6B](https://huggingface.co/Yunhao-Feng/AdaGuard-0.6B) | Trying the smallest member of the family; evaluate suitability for your policy domain. | +| [4B](https://huggingface.co/Yunhao-Feng/AdaGuard-4B) | **Recommended starting point:** close to 8B on AdaptiveSafety with fewer parameters. | +| [8B](https://huggingface.co/Yunhao-Feng/AdaGuard-8B) | The strongest reported aggregate accuracy and rule identification among these three variants. | + +## Quick start + +Use Python 3.10+ and install a PyTorch build appropriate for your device. The example uses **Transformers 5.2.0**, CUDA/BF16 and SDPA. FlashAttention is optional; no custom model code is required. + +Download the small example files first; the model weights are fetched when you load the model: + +```bash +python -m pip install -U huggingface_hub +hf download Yunhao-Feng/AdaGuard-4B \ + --include 'examples/*' --include 'requirements.txt' \ + --local-dir AdaGuard-4B +cd AdaGuard-4B +python -m pip install -r requirements.txt +python examples/quickstart.py +``` + +The included two hand-written cases contrast an attempted protected-file deletion with a refusal. They illustrate the interface and are not benchmark data. + +For Python integration, from the same directory: + +```python +from examples.quickstart import load_guard, predict + +model, tokenizer = load_guard("Yunhao-Feng/AdaGuard-4B") +result = predict(model, tokenizer, { + "policy": [{"id": "R1", "text": "Do not attempt to delete protected files."}], + "content": [[ + {"role": "user", "content": "Delete the protected draft."}, + {"role": "agent", "thought": "I will delete it.", + "action": 'delete_file("protected_draft")'}, + {"role": "environment", "content": "Permission denied; the file still exists."} + ]] +}) +print(result["status"], result["violated_ids"], result["analysis"]) +``` + +`load_guard` uses `AutoTokenizer.from_pretrained` and `AutoModelForCausalLM.from_pretrained` with `trust_remote_code=False`. The helper is ordinary, inspectable example code; it does not require installing the project repository. It supplies the full training prompt, applies the checkpoint's chat template, and validates the generated verdict. + +For your own JSONL inputs: + +```bash +python examples/quickstart.py --input my_inputs.jsonl +``` + +A local checkpoint path can replace the repository ID. CPU (`--device cpu --dtype float32`) and Apple Silicon (`--device mps --dtype float16`) are available for local checks; their outputs and speed are not the reported CUDA/BF16 benchmark results. The 0.6B model is the smallest option for such checks. + +## Input and output + +Each JSONL record has `policy` and `content`: + +- `policy`: a list of `{"id": "R1", "text": "Your rule"}` objects. IDs must be unique, start with a letter, and contain at most 24 ASCII letters, digits, underscores or hyphens. `NR` is reserved. +- `content`: a list of event segments. User and environment events use `role` and `content`; agent events use `role`, `thought` and `action`. A thought may be empty. + +For a **user-only request**, the same interface accepts: + +```json +{"policy": [{"id": "R1", "text": "Requests to delete protected files are prohibited."}], "content": [[{"role": "user", "content": "Delete the protected draft."}]]} +``` + +When agent events are present, the model assesses the agent's behavior. A malicious request alone does not establish an agent violation. Whether an unsuccessful action counts depends on the supplied rule: an attempted deletion violates a rule prohibiting attempts even if the tool refuses it. + +The raw response has exactly this structure (**illustrative format, not a measured model response**): + +```xml + +The agent attempted to delete a protected file. The rule prohibits attempts, even though the tool denied the action. + + +``` + +Use `` for no violations, or `` for multiple violations in policy order. An empty violation set becomes `violated_ids: []` and `unsafe: false` in the parsed result. Malformed, incomplete, duplicated, unknown or out-of-order labels produce `status: "INVALID"`, with `analysis`, `violated_ids` and `unsafe` set to `null`. An invalid response is not a compliant decision. + +The helper uses greedy decoding with up to **512 new tokens** and a **16,000-token prompt budget**. Overlong inputs fail explicitly instead of being silently truncated. The configured context limit is 32,768 tokens including the response; long-context performance beyond the recorded evaluation settings is not established. + +## Evaluation + +**Previously reported results; all values are percentages.** Packaging these checkpoints does not constitute a new benchmark run. The highlighted row is this repository's variant. + +| Model | AdaptiveSafety Acc. | Exact Match | DynaBench Acc. | Exact Match | +|---|---:|---:|---:|---:| +| [AdaGuard-0.6B](https://huggingface.co/Yunhao-Feng/AdaGuard-0.6B) | 82.60 | 68.10 | 51.38 | 44.94 | +| **[AdaGuard-4B](https://huggingface.co/Yunhao-Feng/AdaGuard-4B)** | 89.30 | 76.60 | 71.82 | 63.72 | +| [AdaGuard-8B](https://huggingface.co/Yunhao-Feng/AdaGuard-8B) | 89.50 | 77.10 | 76.80 | 70.72 | + +
+Full binary and rule-identification metrics + +### AdaptiveSafety + +| Model | Accuracy | Precision | Recall | Binary F1 | Exact Match | Rule P | Rule R | Rule F1 | +|---|---:|---:|---:|---:|---:|---:|---:|---:| +| AdaGuard-0.6B | 82.60 | 90.55 | 72.80 | 80.71 | 68.10 | 71.73 | 50.51 | 59.28 | +| AdaGuard-4B | 89.30 | 95.38 | 82.60 | 88.53 | 76.60 | 81.73 | 63.54 | 71.50 | +| AdaGuard-8B | 89.50 | 96.25 | 82.20 | 88.67 | 77.10 | 85.01 | 65.59 | 74.05 | + +### DynaBench + +| Model | Accuracy | Precision | Recall | Binary F1 | Exact Match | Rule P | Rule R | Rule F1 | +|---|---:|---:|---:|---:|---:|---:|---:|---:| +| AdaGuard-0.6B | 51.38 | 50.37 | 76.40 | 60.71 | 44.94 | 40.78 | 66.29 | 50.50 | +| AdaGuard-4B | 71.82 | 70.65 | 73.03 | 71.82 | 63.72 | 51.64 | 58.80 | 54.99 | +| AdaGuard-8B | 76.80 | 77.22 | 74.91 | 76.05 | 70.72 | 61.11 | 65.92 | 63.42 | + +Rule P, Rule R and Rule F1 are micro-averaged across policy-local rule decisions. + +
+ +**Protocol.** AdaptiveSafety contains 1,000 test cases (500 compliant, 500 violating); DynaBench contains 543 (276 compliant, 267 violating). Local inference used BF16 and greedy decoding on eight A100-SXM4-80GB GPUs with one independent replica per GPU, a 16,000-token prompt budget and 512 new tokens. The eight GPUs distributed evaluation cases; they are not a stated requirement for serving one model. No input truncation was recorded for AdaGuard. + +Violations are the positive binary class. Invalid outputs count as binary errors and never receive exact-match credit; for rule micro metrics they contribute an empty predicted set, with reference violations still counted as false negatives. Exact match requires a complete, valid rule set in policy order. Valid empty predictions match empty references. + +These are single-run results. The 4B and 8B variants perform strongly on AdaptiveSafety, while the smaller variant is less consistent on DynaBench. No claim of universal superiority, calibrated uncertainty, or significance across training seeds is implied. + +## Training and model details + +| Item | Value | +|---|---| +| Base model | [Qwen3Guard-Gen-4B](https://huggingface.co/Qwen/Qwen3Guard-Gen-4B) | +| Architecture | `Qwen3ForCausalLM` | +| Training | Supervised fine-tuning on AdaptiveSafety, followed by SafePO | +| Supervised data | 10,939 training examples; 1,000 held-out test examples | +| Policy coverage | 1–100 user-defined rules per example | +| Stored tensors | 4,411,424,256 parameters; FP32 Safetensors | +| Weight download | Approximately 17.65 GB (decimal; weights only) | +| Recommended example precision | BF16 on a compatible CUDA device | +| Configured context | 32,768 tokens; evaluation used the budgets above | +| Chat format | Checkpoint-provided ChatML; `` and `