Update README.md
Browse files
README.md
CHANGED
|
@@ -1,199 +1,188 @@
|
|
| 1 |
---
|
|
|
|
|
|
|
| 2 |
library_name: transformers
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
---
|
| 5 |
|
| 6 |
-
#
|
| 7 |
|
| 8 |
-
|
| 9 |
|
|
|
|
| 10 |
|
|
|
|
| 11 |
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
### Model Description
|
| 15 |
-
|
| 16 |
-
<!-- Provide a longer summary of what this model is. -->
|
| 17 |
-
|
| 18 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 19 |
-
|
| 20 |
-
- **Developed by:** [More Information Needed]
|
| 21 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 22 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 23 |
-
- **Model type:** [More Information Needed]
|
| 24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 25 |
-
- **License:** [More Information Needed]
|
| 26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 27 |
-
|
| 28 |
-
### Model Sources [optional]
|
| 29 |
-
|
| 30 |
-
<!-- Provide the basic links for the model. -->
|
| 31 |
-
|
| 32 |
-
- **Repository:** [More Information Needed]
|
| 33 |
-
- **Paper [optional]:** [More Information Needed]
|
| 34 |
-
- **Demo [optional]:** [More Information Needed]
|
| 35 |
-
|
| 36 |
-
## Uses
|
| 37 |
-
|
| 38 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 39 |
-
|
| 40 |
-
### Direct Use
|
| 41 |
-
|
| 42 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 43 |
-
|
| 44 |
-
[More Information Needed]
|
| 45 |
-
|
| 46 |
-
### Downstream Use [optional]
|
| 47 |
-
|
| 48 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 49 |
-
|
| 50 |
-
[More Information Needed]
|
| 51 |
-
|
| 52 |
-
### Out-of-Scope Use
|
| 53 |
-
|
| 54 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 55 |
|
| 56 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
|
| 58 |
-
|
| 59 |
|
| 60 |
-
|
| 61 |
|
| 62 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 63 |
|
| 64 |
-
|
| 65 |
|
| 66 |
-
|
| 67 |
|
| 68 |
-
|
| 69 |
|
| 70 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 71 |
|
| 72 |
-
|
| 73 |
|
| 74 |
-
|
| 75 |
|
| 76 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 77 |
|
| 78 |
### Training Data
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 79 |
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
[More Information Needed]
|
| 83 |
-
|
| 84 |
-
### Training Procedure
|
| 85 |
-
|
| 86 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 87 |
-
|
| 88 |
-
#### Preprocessing [optional]
|
| 89 |
-
|
| 90 |
-
[More Information Needed]
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
#### Training Hyperparameters
|
| 94 |
-
|
| 95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 96 |
-
|
| 97 |
-
#### Speeds, Sizes, Times [optional]
|
| 98 |
-
|
| 99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 100 |
-
|
| 101 |
-
[More Information Needed]
|
| 102 |
-
|
| 103 |
-
## Evaluation
|
| 104 |
-
|
| 105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 106 |
-
|
| 107 |
-
### Testing Data, Factors & Metrics
|
| 108 |
-
|
| 109 |
-
#### Testing Data
|
| 110 |
-
|
| 111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 112 |
-
|
| 113 |
-
[More Information Needed]
|
| 114 |
-
|
| 115 |
-
#### Factors
|
| 116 |
-
|
| 117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 118 |
-
|
| 119 |
-
[More Information Needed]
|
| 120 |
-
|
| 121 |
-
#### Metrics
|
| 122 |
-
|
| 123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 124 |
-
|
| 125 |
-
[More Information Needed]
|
| 126 |
-
|
| 127 |
-
### Results
|
| 128 |
-
|
| 129 |
-
[More Information Needed]
|
| 130 |
-
|
| 131 |
-
#### Summary
|
| 132 |
|
|
|
|
| 133 |
|
|
|
|
| 134 |
|
| 135 |
-
|
|
|
|
|
|
|
|
|
|
| 136 |
|
| 137 |
-
|
| 138 |
|
| 139 |
-
|
| 140 |
|
| 141 |
-
|
| 142 |
|
| 143 |
-
|
| 144 |
|
| 145 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 146 |
|
| 147 |
-
|
| 148 |
-
- **Hours used:** [More Information Needed]
|
| 149 |
-
- **Cloud Provider:** [More Information Needed]
|
| 150 |
-
- **Compute Region:** [More Information Needed]
|
| 151 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 152 |
|
| 153 |
-
|
|
|
|
|
|
|
| 154 |
|
| 155 |
-
|
| 156 |
|
| 157 |
-
|
| 158 |
|
| 159 |
-
|
| 160 |
|
| 161 |
-
|
|
|
|
|
|
|
| 162 |
|
| 163 |
-
|
| 164 |
|
| 165 |
-
|
| 166 |
|
| 167 |
-
|
|
|
|
|
|
|
| 168 |
|
| 169 |
-
|
|
|
|
|
|
|
| 170 |
|
| 171 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 172 |
|
| 173 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 174 |
|
| 175 |
-
|
| 176 |
|
| 177 |
-
|
| 178 |
|
| 179 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 180 |
|
| 181 |
-
|
| 182 |
|
| 183 |
-
##
|
| 184 |
|
| 185 |
-
|
|
|
|
|
|
|
|
|
|
| 186 |
|
| 187 |
-
|
| 188 |
|
| 189 |
-
##
|
| 190 |
|
| 191 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 192 |
|
| 193 |
-
|
| 194 |
|
| 195 |
-
|
| 196 |
|
| 197 |
-
|
|
|
|
|
|
|
|
|
|
| 198 |
|
| 199 |
-
|
|
|
|
| 1 |
---
|
| 2 |
+
base_model: openai/gpt-oss-20b
|
| 3 |
+
base_model_relation: merge
|
| 4 |
library_name: transformers
|
| 5 |
+
pipeline_tag: text-generation
|
| 6 |
+
tags:
|
| 7 |
+
- sft
|
| 8 |
+
- transformers
|
| 9 |
+
- trl
|
| 10 |
+
license: apache-2.0
|
| 11 |
+
language:
|
| 12 |
+
- en
|
| 13 |
+
- ko
|
| 14 |
---
|
| 15 |
|
| 16 |
+
# Vayne-V1
|
| 17 |
|
| 18 |
+
**Vayne-V1** is a **high-performance enterprise LLM** engineered for **AI agent frameworks**, **MCP-based tool orchestration**, **RAG (Retrieval-Augmented Generation) pipelines**, and **secure on-premise deployment**.
|
| 19 |
|
| 20 |
+
---
|
| 21 |
|
| 22 |
+
## 1. Model Overview
|
| 23 |
|
| 24 |
+
Vayne-V1 enables enterprises to build **internal AI assistants, automation agents, and retrieval-based knowledge systems** securely within their own infrastructure. It supports **local GPU environments**, making it ideal for **compliance-sensitive industries** such as finance, manufacturing, telecom, defense, and healthcare.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 25 |
|
| 26 |
+
### Key Design Principles
|
| 27 |
+
- **Private AI Ready** – Deployable fully **on-premise** or **air-gapped**
|
| 28 |
+
- **Single-GPU Inference** – Optimized lightweight architecture
|
| 29 |
+
- **Enterprise Reasoning** – Structured responses for real business use cases
|
| 30 |
+
- **Agent & MCP Optimized** – Plug-and-play AI agent compatibility
|
| 31 |
+
- **RAG Enhanced** – Built to work with vector databases for knowledge retrieval
|
| 32 |
|
| 33 |
+
---
|
| 34 |
|
| 35 |
+
## 2. Key Capabilities
|
| 36 |
|
| 37 |
+
| Capability | Description |
|
| 38 |
+
|------------|-------------|
|
| 39 |
+
| Local Deployment | Runs securely within enterprise infrastructure |
|
| 40 |
+
| MCP Integration | Compatible with **Model Context Protocol** for tool-use AI |
|
| 41 |
+
| Agent Ready | Works with LangChain, CrewAI, AutoGen, TaskWeaver |
|
| 42 |
+
| RAG Optimized | Designed for document retrieval pipelines |
|
| 43 |
+
| Structured Output | JSON, function-style responses for automation |
|
| 44 |
+
| Bilingual | English + Korean hybrid enterprise workflow support |
|
| 45 |
|
| 46 |
+
---
|
| 47 |
|
| 48 |
+
## 3. Why Vayne-V1?
|
| 49 |
|
| 50 |
+
Unlike cloud-restricted LLMs, Vayne-V1 enables **complete AI independence**:
|
| 51 |
|
| 52 |
+
✅ Full data sovereignty – no data leaves your environment
|
| 53 |
+
✅ Runs on NVIDIA 3090, 4090, A100, L40S, etc.
|
| 54 |
+
✅ Ideal for secure enterprise AI stacks
|
| 55 |
+
✅ Ready for internal AI copilots and automation agents
|
| 56 |
+
✅ No vendor lock-in
|
| 57 |
|
| 58 |
+
---
|
| 59 |
|
| 60 |
+
## 4. Model Architecture & Training
|
| 61 |
|
| 62 |
+
| Specification | Details |
|
| 63 |
+
|---------------|---------|
|
| 64 |
+
| Base Model | GPT-OSS-20B |
|
| 65 |
+
| Parameters | ~20B |
|
| 66 |
+
| Precision | FP16/BF16 |
|
| 67 |
+
| Context Length | 4K tokens |
|
| 68 |
+
| Type | Decoder-only Transformer |
|
| 69 |
|
| 70 |
### Training Data
|
| 71 |
+
Fine-tuned using supervised instruction tuning (SFT) on:
|
| 72 |
+
- Enterprise QA datasets
|
| 73 |
+
- Task reasoning + tool usage instructions
|
| 74 |
+
- RAG-style retrieval prompts
|
| 75 |
+
- Business reports & structured communication
|
| 76 |
+
- Korean–English bilingual QA and translation
|
| 77 |
+
- Synthetic instructions with safety curation
|
| 78 |
|
| 79 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 80 |
|
| 81 |
+
## 5. Secure On-Premise Deployment
|
| 82 |
|
| 83 |
+
Vayne-V1 is built for **enterprise AI inside your firewall**.
|
| 84 |
|
| 85 |
+
✅ No external API dependency
|
| 86 |
+
✅ Compatible with **offline environments**
|
| 87 |
+
✅ Supports air-gapped GPU clusters
|
| 88 |
+
✅ Proven for secure deployments
|
| 89 |
|
| 90 |
+
---
|
| 91 |
|
| 92 |
+
## 6. MCP (Model Context Protocol) Integration
|
| 93 |
|
| 94 |
+
Vayne-V1 supports **MCP-based agent tooling**, making it easy to integrate tool-use AI.
|
| 95 |
|
| 96 |
+
Example function-style output:
|
| 97 |
|
| 98 |
+
```json
|
| 99 |
+
{
|
| 100 |
+
"tool": "search_documents",
|
| 101 |
+
"arguments": { "query": "AI strategy in manufacturing industry" }
|
| 102 |
+
}
|
| 103 |
+
````
|
| 104 |
|
| 105 |
+
Works seamlessly with:
|
|
|
|
|
|
|
|
|
|
|
|
|
| 106 |
|
| 107 |
+
* Claude MCP-compatible agent systems
|
| 108 |
+
* Local agent runtimes
|
| 109 |
+
* JSON structured execution
|
| 110 |
|
| 111 |
+
---
|
| 112 |
|
| 113 |
+
## 7. RAG Compatibility
|
| 114 |
|
| 115 |
+
Designed for **hybrid reasoning + retrieval**.
|
| 116 |
|
| 117 |
+
✅ Works with FAISS, Chroma, Elasticsearch
|
| 118 |
+
✅ Handles long-context document QA
|
| 119 |
+
✅ Ideal for enterprise knowledge bases
|
| 120 |
|
| 121 |
+
---
|
| 122 |
|
| 123 |
+
## 8. Quick Start
|
| 124 |
|
| 125 |
+
```bash
|
| 126 |
+
pip install transformers peft accelerate bitsandbytes
|
| 127 |
+
```
|
| 128 |
|
| 129 |
+
```python
|
| 130 |
+
from transformers import AutoModelForCausalLM, AutoTokenizer
|
| 131 |
+
import torch
|
| 132 |
|
| 133 |
+
model_name = "PoSTMEDIA/Vayne-V1"
|
| 134 |
+
tokenizer = AutoTokenizer.from_pretrained(model_name)
|
| 135 |
+
model = AutoModelForCausalLM.from_pretrained(
|
| 136 |
+
model_name,
|
| 137 |
+
torch_dtype=torch.float16,
|
| 138 |
+
device_map="auto"
|
| 139 |
+
)
|
| 140 |
|
| 141 |
+
prompt = "Explain the benefits of private AI for enterprise security."
|
| 142 |
+
inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
|
| 143 |
+
outputs = model.generate(**inputs, max_length=256)
|
| 144 |
+
print(tokenizer.decode(outputs[0], skip_special_tokens=True))
|
| 145 |
+
```
|
| 146 |
|
| 147 |
+
---
|
| 148 |
|
| 149 |
+
## 9. Use Cases
|
| 150 |
|
| 151 |
+
✅ Internal enterprise AI assistant
|
| 152 |
+
✅ Private AI document analysis
|
| 153 |
+
✅ Business writing (reports, proposals, strategy)
|
| 154 |
+
✅ AI automation agents
|
| 155 |
+
✅ Secure RAG search systems
|
| 156 |
|
| 157 |
+
---
|
| 158 |
|
| 159 |
+
## 10. Safety & Limitations
|
| 160 |
|
| 161 |
+
* Not intended for medical, legal, or financial decision-making
|
| 162 |
+
* May occasionally generate hallucinations
|
| 163 |
+
* Use human validation for critical outputs
|
| 164 |
+
* Recommended: enable output guardrails for production
|
| 165 |
|
| 166 |
+
---
|
| 167 |
|
| 168 |
+
## Citation
|
| 169 |
|
| 170 |
+
```bibtex
|
| 171 |
+
@misc{vayne2025,
|
| 172 |
+
title={Vayne-V1: Private On-Premise LLM Optimized for Agents and RAG},
|
| 173 |
+
author={PoSTMEDIA AI Lab},
|
| 174 |
+
year={2025},
|
| 175 |
+
publisher={Hugging Face}
|
| 176 |
+
}
|
| 177 |
+
```
|
| 178 |
|
| 179 |
+
---
|
| 180 |
|
| 181 |
+
## Contact
|
| 182 |
|
| 183 |
+
**PoSTMEDIA AI Lab**
|
| 184 |
+
📧 [dev.postmedia@gmail.com](mailto:dev.postmedia@gmail.com)
|
| 185 |
+
🌐 [https://postmedia.ai](https://postmedia.ai)
|
| 186 |
+
🌐 [https://postmedia.co.kr](https://postmedia.co.kr)
|
| 187 |
|
| 188 |
+
---
|