syed7741 commited on
Commit
6ed6891
·
verified ·
1 Parent(s): ff66fd1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -17
README.md CHANGED
@@ -8,7 +8,7 @@ base_model: google/flan-t5-small
8
  base_model_relation: adapter
9
 
10
  library_name: peft
11
- pipeline_tag: text2text-generation
12
 
13
  datasets:
14
  - syed7741/aegis-industrial-ai-dataset
@@ -52,9 +52,7 @@ The project is part of **AEGIS AI**, an end-to-end industrial artificial intelli
52
 
53
  # Model Status
54
 
55
- ✅ **This repository now contains a genuinely trained LoRA adapter.**
56
-
57
- It is no longer only a documentation repository.
58
 
59
  The trained adapter weights are stored in:
60
 
@@ -154,8 +152,6 @@ Final evaluation examples:
154
 
155
  The model was trained using **LoRA — Low-Rank Adaptation** through Hugging Face PEFT.
156
 
157
- Configuration:
158
-
159
  | Parameter | Value |
160
  |---|---:|
161
  | Base model | google/flan-t5-small |
@@ -213,7 +209,7 @@ Training Loss: 1.1880
213
  Evaluation Loss: 0.7744
214
  ```
215
 
216
- Both the training and evaluation loss decreased during the two training epochs.
217
 
218
  ---
219
 
@@ -243,7 +239,7 @@ Install the required libraries:
243
  pip install transformers peft torch sentencepiece
244
  ```
245
 
246
- Then load the AEGIS adapter:
247
 
248
  ```python
249
  from transformers import (
@@ -267,6 +263,7 @@ config = PeftConfig.from_pretrained(
267
  ADAPTER_ID
268
  )
269
 
 
270
  base_model = (
271
  AutoModelForSeq2SeqLM
272
  .from_pretrained(
@@ -274,6 +271,7 @@ base_model = (
274
  )
275
  )
276
 
 
277
  tokenizer = (
278
  AutoTokenizer
279
  .from_pretrained(
@@ -281,16 +279,16 @@ tokenizer = (
281
  )
282
  )
283
 
 
284
  model = PeftModel.from_pretrained(
285
  base_model,
286
  ADAPTER_ID,
287
  )
288
 
 
289
  model.eval()
290
  ```
291
 
292
- PEFT adapters are loaded together with their original base model.
293
-
294
  ---
295
 
296
  # Example Inference
@@ -387,7 +385,7 @@ The embedding model performs semantic retrieval over the industrial knowledge ba
387
 
388
  # Technology Stack
389
 
390
- ### AI / Machine Learning
391
 
392
  - Hugging Face
393
  - Transformers
@@ -399,20 +397,20 @@ The embedding model performs semantic retrieval over the industrial knowledge ba
399
  - Semantic Search
400
  - Vector Embeddings
401
 
402
- ### Backend
403
 
404
  - Python
405
  - FastAPI
406
  - REST APIs
407
  - PostgreSQL
408
 
409
- ### Frontend
410
 
411
  - React
412
  - TypeScript
413
  - Material UI
414
 
415
- ### AI Platform Components
416
 
417
  - RAG
418
  - AI Agents
@@ -450,7 +448,7 @@ Implemented:
450
 
451
  # Development Roadmap
452
 
453
- Planned improvements include:
454
 
455
  - Larger industrial training dataset
456
  - Arabic + English training data
@@ -475,7 +473,7 @@ AEGIS demonstrates concepts applicable to enterprise AI systems including:
475
 
476
  - LLM application development
477
  - Parameter-efficient fine-tuning
478
- - RAG
479
  - Document intelligence
480
  - Semantic search
481
  - Conversational AI
@@ -489,7 +487,7 @@ AEGIS demonstrates concepts applicable to enterprise AI systems including:
489
 
490
  # Safety Notice
491
 
492
- The AEGIS training dataset currently contains **synthetic industrial records** created for:
493
 
494
  - AI engineering experimentation
495
  - learning
 
8
  base_model_relation: adapter
9
 
10
  library_name: peft
11
+ pipeline_tag: text-generation
12
 
13
  datasets:
14
  - syed7741/aegis-industrial-ai-dataset
 
52
 
53
  # Model Status
54
 
55
+ ✅ **This repository contains a genuinely trained LoRA adapter.**
 
 
56
 
57
  The trained adapter weights are stored in:
58
 
 
152
 
153
  The model was trained using **LoRA — Low-Rank Adaptation** through Hugging Face PEFT.
154
 
 
 
155
  | Parameter | Value |
156
  |---|---:|
157
  | Base model | google/flan-t5-small |
 
209
  Evaluation Loss: 0.7744
210
  ```
211
 
212
+ Both training and evaluation loss decreased during the two training epochs.
213
 
214
  ---
215
 
 
239
  pip install transformers peft torch sentencepiece
240
  ```
241
 
242
+ Load the AEGIS adapter:
243
 
244
  ```python
245
  from transformers import (
 
263
  ADAPTER_ID
264
  )
265
 
266
+
267
  base_model = (
268
  AutoModelForSeq2SeqLM
269
  .from_pretrained(
 
271
  )
272
  )
273
 
274
+
275
  tokenizer = (
276
  AutoTokenizer
277
  .from_pretrained(
 
279
  )
280
  )
281
 
282
+
283
  model = PeftModel.from_pretrained(
284
  base_model,
285
  ADAPTER_ID,
286
  )
287
 
288
+
289
  model.eval()
290
  ```
291
 
 
 
292
  ---
293
 
294
  # Example Inference
 
385
 
386
  # Technology Stack
387
 
388
+ ## AI / Machine Learning
389
 
390
  - Hugging Face
391
  - Transformers
 
397
  - Semantic Search
398
  - Vector Embeddings
399
 
400
+ ## Backend
401
 
402
  - Python
403
  - FastAPI
404
  - REST APIs
405
  - PostgreSQL
406
 
407
+ ## Frontend
408
 
409
  - React
410
  - TypeScript
411
  - Material UI
412
 
413
+ ## AI Platform Components
414
 
415
  - RAG
416
  - AI Agents
 
448
 
449
  # Development Roadmap
450
 
451
+ Planned improvements:
452
 
453
  - Larger industrial training dataset
454
  - Arabic + English training data
 
473
 
474
  - LLM application development
475
  - Parameter-efficient fine-tuning
476
+ - Retrieval-Augmented Generation
477
  - Document intelligence
478
  - Semantic search
479
  - Conversational AI
 
487
 
488
  # Safety Notice
489
 
490
+ The AEGIS training dataset contains **synthetic industrial records** created for:
491
 
492
  - AI engineering experimentation
493
  - learning