Update README.md
Browse files
README.md
CHANGED
@@ -1,201 +1,79 @@
|
|
1 |
-
---
|
2 |
library_name: transformers
|
3 |
-
tags: []
|
4 |
-
---
|
5 |
-
|
6 |
-
# Model Card for Model ID
|
7 |
-
|
8 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
9 |
|
|
|
10 |
|
|
|
11 |
|
12 |
## Model Details
|
13 |
|
14 |
### Model Description
|
15 |
|
16 |
-
|
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:**
|
21 |
-
- **
|
22 |
-
- **
|
23 |
-
- **
|
24 |
-
- **
|
25 |
-
- **License:** [More Information Needed]
|
26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
27 |
|
28 |
-
### Model Sources
|
29 |
|
30 |
-
|
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 |
-
|
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 |
-
[More Information Needed]
|
57 |
|
58 |
## Bias, Risks, and Limitations
|
59 |
|
60 |
-
|
61 |
-
|
62 |
-
[More Information Needed]
|
63 |
|
64 |
### Recommendations
|
65 |
|
66 |
-
|
67 |
-
|
68 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
69 |
|
70 |
## How to Get Started with the Model
|
71 |
|
72 |
-
|
73 |
-
|
74 |
-
[More Information Needed]
|
75 |
-
|
76 |
-
## Training Details
|
77 |
-
|
78 |
-
### Training Data
|
79 |
-
|
80 |
-
<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
|
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 |
-
|
|
|
114 |
|
115 |
-
|
|
|
|
|
|
|
|
|
116 |
|
117 |
-
|
|
|
|
|
118 |
|
119 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
120 |
|
121 |
-
|
122 |
-
|
123 |
-
|
124 |
-
|
125 |
-
[More Information Needed]
|
126 |
|
127 |
### Results
|
128 |
|
129 |
-
|
130 |
-
|
131 |
-
#### Summary
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
## Model Examination [optional]
|
136 |
-
|
137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
138 |
-
|
139 |
-
[More Information Needed]
|
140 |
|
141 |
## Environmental Impact
|
142 |
|
143 |
-
|
144 |
-
|
145 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
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 |
-
## Technical Specifications [optional]
|
154 |
|
155 |
### Model Architecture and Objective
|
156 |
|
157 |
-
|
158 |
-
|
159 |
-
### Compute Infrastructure
|
160 |
-
|
161 |
-
[More Information Needed]
|
162 |
-
|
163 |
-
#### Hardware
|
164 |
-
|
165 |
-
[More Information Needed]
|
166 |
-
|
167 |
-
#### Software
|
168 |
-
|
169 |
-
[More Information Needed]
|
170 |
-
|
171 |
-
## Citation [optional]
|
172 |
-
|
173 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
174 |
-
|
175 |
-
**BibTeX:**
|
176 |
-
|
177 |
-
[More Information Needed]
|
178 |
-
|
179 |
-
**APA:**
|
180 |
-
|
181 |
-
[More Information Needed]
|
182 |
-
|
183 |
-
## Glossary [optional]
|
184 |
-
|
185 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
186 |
-
|
187 |
-
[More Information Needed]
|
188 |
-
|
189 |
-
## More Information [optional]
|
190 |
-
|
191 |
-
[More Information Needed]
|
192 |
-
|
193 |
-
## Model Card Authors [optional]
|
194 |
-
|
195 |
-
[More Information Needed]
|
196 |
-
|
197 |
-
## Model Card Contact
|
198 |
-
|
199 |
-
[More Information Needed]
|
200 |
-
|
201 |
-
|
|
|
|
|
1 |
library_name: transformers
|
2 |
+
tags: [chaos-engineering, IT-infrastructure, H.A.N.D.S, python, AI]
|
|
|
|
|
|
|
|
|
|
|
3 |
|
4 |
+
# Model Card for phi-2-chaos-gen
|
5 |
|
6 |
+
This model card describes the phi-2-chaos-gen, a fine-tuned version of the PHI-2 model, specialized in generating insights and strategies for chaos engineering in IT infrastructures.
|
7 |
|
8 |
## Model Details
|
9 |
|
10 |
### Model Description
|
11 |
|
12 |
+
The phi-2-chaos-gen is a fine-tuned version of the PHI-2 model, developed to assist in chaos engineering for IT infrastructures. It utilizes a unique methodology called H.A.N.D.S (Hardware, Application, Network, Data, Security) to generate relevant strategies and insights. This model aims to provide comprehensive chaos engineering solutions, focusing on each aspect of IT infrastructure.
|
|
|
|
|
13 |
|
14 |
+
- **Developed by:** Webnizam
|
15 |
+
- **Model type:** Text generation
|
16 |
+
- **Language(s) (NLP):** English
|
17 |
+
- **License:** MIT License
|
18 |
+
- **Finetuned from model:** Microsoft's PHI-2
|
|
|
|
|
19 |
|
20 |
+
### Model Sources
|
21 |
|
22 |
+
- **Repository:** [webnizam/phi-2-chaos-gen](https://huggingface.co/webnizam/phi-2-chaos-gen)
|
|
|
|
|
|
|
|
|
23 |
|
24 |
## Uses
|
25 |
|
|
|
|
|
26 |
### Direct Use
|
27 |
|
28 |
+
The model can be directly used by IT professionals and organizations to generate strategies and insights for chaos engineering in their IT infrastructure, focusing on hardware, application, network, data, and security aspects.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
29 |
|
30 |
## Bias, Risks, and Limitations
|
31 |
|
32 |
+
The model, while powerful, may have limitations in understanding highly specialized or newly emerging IT concepts. Users should verify the model's recommendations with current IT standards and practices.
|
|
|
|
|
33 |
|
34 |
### Recommendations
|
35 |
|
36 |
+
It's recommended to use this model as a starting point or a complement to existing chaos engineering practices, not as a sole source of truth.
|
|
|
|
|
37 |
|
38 |
## How to Get Started with the Model
|
39 |
|
40 |
+
To use the phi-2-chaos-gen model, follow these steps:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
41 |
|
42 |
+
1. **Installation:**
|
43 |
+
Install the transformers library using pip:
|
44 |
|
45 |
+
```bash
|
46 |
+
pip install transformers
|
47 |
+
```
|
48 |
+
2. **Loading the Model:**
|
49 |
+
Load the phi-2-chaos-gen model using the transformers package. Ensure you have an internet connection as the model will be downloaded the first time you run this code.
|
50 |
|
51 |
+
```python
|
52 |
+
from transformers import AutoModelForCausalLM, AutoTokenizer
|
53 |
+
```
|
54 |
|
55 |
+
tokenizer = AutoTokenizer.from_pretrained("webnizam/phi-2-chaos-gen")
|
56 |
+
model = AutoModelForCausalLM.from_pretrained("webnizam/phi-2-chaos-gen")
|
57 |
+
3. **Using the Model:**
|
58 |
+
You can now use the model to generate text. For example:
|
59 |
+
```python
|
60 |
+
input_text = "Scenario: Network failure in multi-cloud environment. Strategy:"
|
61 |
+
input_ids = tokenizer.encode(input_text, return_tensors='pt')
|
62 |
|
63 |
+
output = model.generate(input_ids, max_length=100, num_return_sequences=1)
|
64 |
+
print(tokenizer.decode(output[0], skip_special_tokens=True))
|
65 |
+
```
|
|
|
|
|
66 |
|
67 |
### Results
|
68 |
|
69 |
+
The model showed proficiency in generating relevant and practical strategies for different scenarios within the scope of H.A.N.D.S.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
70 |
|
71 |
## Environmental Impact
|
72 |
|
73 |
+
The training of this model was conducted with a focus on minimizing its carbon footprint. Specific details on the environmental impact are available upon request.
|
|
|
|
|
74 |
|
75 |
+
## Technical Specifications
|
|
|
|
|
|
|
|
|
|
|
|
|
76 |
|
77 |
### Model Architecture and Objective
|
78 |
|
79 |
+
The model follows the architecture of the PHI-2 model, fine-tuned for text generation in the context of chaos engineering.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|