mattmajestic commited on
Commit
420b8cd
Β·
verified Β·
1 Parent(s): b00aa55

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -24
README.md CHANGED
@@ -6,14 +6,8 @@ model-index:
6
  type: text-generation
7
  dataset:
8
  name: rag_contents
9
- type: custom
10
  metrics:
11
- - name: Perplexity
12
- type: perplexity
13
- value: 20.75 # Example value, update with your actual score
14
- - name: BLEU
15
- type: bleu
16
- value: 35.5 # Example value, update with your actual score
17
  - name: Retrieval Accuracy
18
  type: custom
19
  value: 85.0 # Example value, update with your actual score
@@ -25,36 +19,36 @@ model-index:
25
  metrics:
26
  - name: Pricing Retrieval Accuracy
27
  type: custom
28
- value: 88.5 # Example value, update with your actual score
29
  source:
30
  name: Cloud Cents
31
- url: https://cloud-cents.vercel.app
32
  ---
33
 
34
- # Cloud Service RAG Model
35
 
36
- ## Model Description
37
- This model is a fine-tuned GPT-2 model designed to answer cloud-related questions about AWS, Azure, GCP, and other cloud platforms. It uses Retrieval-Augmented Generation (RAG) to combine document retrieval with text generation, leveraging cloud-related documents and real-time pricing information.
38
 
39
- ## Intended Use
40
- - Cloud service comparisons (e.g., AWS vs Azure)
41
- - Real-time cloud pricing queries
42
- - General information about cloud platforms and services
43
 
44
- ## Pipeline
45
  `text-generation` with `retrieval-augmented generation (RAG)`
46
- - Document retrieval from `rag_contents` and `pricing_info`
47
- - Text generation using fine-tuned GPT-2
48
 
49
- ## Datasets
50
  - **rag_contents**: Contains cloud-related documents from sources such as AWS, Azure, GCP.
51
  - **pricing_info**: Provides real-time pricing details for cloud services (e.g., EC2, Blob Storage, Container Registry).
52
 
53
- ## Metrics
54
  - **Perplexity**: Evaluated for fluency of text generation.
55
  - **BLEU**: Used for measuring the accuracy of generated answers.
56
  - **Retrieval Accuracy**: Custom metric for FAISS-based document retrieval.
57
 
58
- ## Limitations
59
- - The model may not always retrieve the most up-to-date information about cloud services.
60
- - The retrieval and generation quality is based on the documents stored in the `rag_contents` table.
 
6
  type: text-generation
7
  dataset:
8
  name: rag_contents
9
+ type: pricing_info
10
  metrics:
 
 
 
 
 
 
11
  - name: Retrieval Accuracy
12
  type: custom
13
  value: 85.0 # Example value, update with your actual score
 
19
  metrics:
20
  - name: Pricing Retrieval Accuracy
21
  type: custom
22
+ value: 75
23
  source:
24
  name: Cloud Cents
25
+ url: https://huggingface.co/mattmajestic/cloud-llm
26
  ---
27
 
28
+ # ☁️ Cloud Cents RAG Model ☁️
29
 
30
+ ## πŸ“– Model Description
31
+ This model is a fine-tuned GPT-2 model designed to answer cloud-related questions about AWS, Azure, GCP, and other cloud platforms. It uses **Retrieval-Augmented Generation (RAG)** to combine document retrieval with text generation, leveraging cloud-related documents and real-time pricing information.
32
 
33
+ ## πŸ›  Intended Use
34
+ - πŸ” Cloud service comparisons (e.g., AWS vs Azure)
35
+ - πŸ’° Real-time cloud pricing queries
36
+ - 🌐 General information about cloud platforms and services
37
 
38
+ ## πŸ”§ Pipeline
39
  `text-generation` with `retrieval-augmented generation (RAG)`
40
+ - πŸ“š Document retrieval from `rag_contents` and `pricing_info`
41
+ - ✍️ Text generation using fine-tuned GPT-2
42
 
43
+ ## πŸ“Š Datasets
44
  - **rag_contents**: Contains cloud-related documents from sources such as AWS, Azure, GCP.
45
  - **pricing_info**: Provides real-time pricing details for cloud services (e.g., EC2, Blob Storage, Container Registry).
46
 
47
+ ## πŸ“ˆ Metrics
48
  - **Perplexity**: Evaluated for fluency of text generation.
49
  - **BLEU**: Used for measuring the accuracy of generated answers.
50
  - **Retrieval Accuracy**: Custom metric for FAISS-based document retrieval.
51
 
52
+ ## ⚠️ Limitations
53
+ - πŸ•‘ The model may not always retrieve the most up-to-date information about cloud services.
54
+ - πŸ“‚ The retrieval and generation quality is based on the documents stored in the `rag_contents` table.