rvong8 commited on
Commit
a08ee4e
·
verified ·
1 Parent(s): d661191

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -9
README.md CHANGED
@@ -5,35 +5,37 @@ tags:
5
  - t5
6
  - text2text-generation
7
  - security
8
- - oracle-shield
9
  ---
10
 
11
- # Oracle Shield — T5 log Q&A
12
 
13
  ## What this is
14
 
15
- A **T5** conditional-generation checkpoint fine-tuned for Oracle Shield.
16
 
17
  Used for **log-oriented** prompts (e.g. explaining or answering questions about a security log string). The app generates a short text response via `T5ForConditionalGeneration.generate(...)`.
18
 
19
  ## Project
20
 
21
- Part of **Oracle Shield** (Django + React): paste a security log or ask a cybersecurity question.
22
 
23
- This repository holds **weights only**. Application code is in the public Oracle Shield GitHub repository.
24
 
25
  ## Training note
26
 
27
  This is a **custom fine-tune**, not an unmodified public T5 base/small checkpoint. A generic Hub T5 model is not a guaranteed substitute for this artifact.
28
 
 
 
29
  ## Intended use
30
 
31
- - Running the Oracle Shield full-ML path locally
32
  - Experimentation and educational use with the companion application
33
 
34
  **Not** a production SOC product. No warranty. Generated text can be incomplete or incorrect; do not use for live security operations without your own validation.
35
 
36
- ## How Oracle Shield loads it
37
 
38
  Local path after download:
39
 
@@ -41,12 +43,27 @@ Local path after download:
41
  backend/models/cyber_qa_t5_model_log/
42
  ```
43
 
44
- Loaded with `T5ForConditionalGeneration.from_pretrained(<local_or_hub_id>)` when `ORACLE_DEMO_MODE=false`.
45
 
46
  ## Files
47
 
48
  Expect a standard Transformers export, e.g. `model.safetensors`, `config.json`, `spiece.model`, tokenizer config files.
49
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
  ## License
51
 
52
- Apache License 2.0. Demo only — provided as-is, without warranty of any kind.
 
 
 
5
  - t5
6
  - text2text-generation
7
  - security
8
+ - arbiter
9
  ---
10
 
11
+ # Arbiter — T5 log Q&A
12
 
13
  ## What this is
14
 
15
+ A **T5** conditional-generation checkpoint fine-tuned for **[Arbiter](https://github.com/SentinelSage/arbiter)**.
16
 
17
  Used for **log-oriented** prompts (e.g. explaining or answering questions about a security log string). The app generates a short text response via `T5ForConditionalGeneration.generate(...)`.
18
 
19
  ## Project
20
 
21
+ Part of **Arbiter** (Django + React): paste a security log or ask a cybersecurity question.
22
 
23
+ This repository holds **weights only**. Application code: [github.com/SentinelSage/arbiter](https://github.com/SentinelSage/arbiter).
24
 
25
  ## Training note
26
 
27
  This is a **custom fine-tune**, not an unmodified public T5 base/small checkpoint. A generic Hub T5 model is not a guaranteed substitute for this artifact.
28
 
29
+ **Training data:** custom-curated, **unpublished** project data. Training tables are not published with the app.
30
+
31
  ## Intended use
32
 
33
+ - Running the Arbiter full-ML path locally
34
  - Experimentation and educational use with the companion application
35
 
36
  **Not** a production SOC product. No warranty. Generated text can be incomplete or incorrect; do not use for live security operations without your own validation.
37
 
38
+ ## How Arbiter loads it
39
 
40
  Local path after download:
41
 
 
43
  backend/models/cyber_qa_t5_model_log/
44
  ```
45
 
46
+ Loaded with `T5ForConditionalGeneration.from_pretrained(<local_or_hub_id>)` when `ARBITER_DEMO_MODE=false`.
47
 
48
  ## Files
49
 
50
  Expect a standard Transformers export, e.g. `model.safetensors`, `config.json`, `spiece.model`, tokenizer config files.
51
 
52
+ ## Method / citations
53
+
54
+ - **T5:** Raffel, C., et al. (2020). *Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer.* JMLR.
55
+ [T5 docs](https://huggingface.co/docs/transformers/model_doc/t5)
56
+ - **Transformers:** Wolf, T., et al. (2020). *Transformers: State-of-the-Art Natural Language Processing.* EMNLP.
57
+ [huggingface/transformers](https://github.com/huggingface/transformers)
58
+ - **PyTorch:** Paszke, A., et al. (2019). *PyTorch: An Imperative Style, High-Performance Deep Learning Library.* NeurIPS.
59
+ [pytorch/pytorch](https://github.com/pytorch/pytorch)
60
+
61
+ ## Safety
62
+
63
+ Research / portfolio demo only. Do not paste production logs, PII, or credentials into shared demos using these weights.
64
+
65
  ## License
66
 
67
+ Apache License 2.0. Demo only — provided as-is, without warranty of any kind.
68
+
69
+ Copyright 2026 Ryan Vong / Sentinel Sage