RichardErkhov commited on
Commit
0f6e5f1
·
verified ·
1 Parent(s): a4e7867

uploaded readme

Browse files
Files changed (1) hide show
  1. README.md +141 -0
README.md ADDED
@@ -0,0 +1,141 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Quantization made by Richard Erkhov.
2
+
3
+ [Github](https://github.com/RichardErkhov)
4
+
5
+ [Discord](https://discord.gg/pvy7H8DZMG)
6
+
7
+ [Request more models](https://github.com/RichardErkhov/quant_request)
8
+
9
+
10
+ GPT-NEO-1.3B-wiki - bnb 8bits
11
+ - Model creator: https://huggingface.co/Kimargin/
12
+ - Original model: https://huggingface.co/Kimargin/GPT-NEO-1.3B-wiki/
13
+
14
+
15
+
16
+
17
+ Original model description:
18
+ ---
19
+ library_name: transformers
20
+ language:
21
+ - en
22
+ base_model:
23
+ - EleutherAI/gpt-neo-1.3B
24
+ license: apache-2.0
25
+ datasets:
26
+ - legacy-datasets/wikipedia
27
+ metrics:
28
+ - perplexity
29
+ - accuracy
30
+ new_version: Kimargin/GPT-NEO-1.3B-wiki
31
+ ---
32
+
33
+ # Model Card for GPT-NEO-1.3B-wiki
34
+
35
+ ## Model Details
36
+
37
+ ### Model Description
38
+
39
+ This model is based on [EleutherAI/gpt-neo-1.3B](https://huggingface.co/EleutherAI/gpt-neo-1.3B) and has been fine-tuned on the Wikipedia dataset. It is designed for text generation tasks such as summarization, question answering, and text completion in English. The model is fine-tuned to improve the fluency and factual accuracy of the generated content.
40
+
41
+ - **Developed by:** Kimargin
42
+ - **Model type:** Fine-tuned model
43
+ - **Language(s):** English
44
+ - **License:** Apache 2.0
45
+ - **Finetuned from model:** EleutherAI/gpt-neo-1.3B
46
+
47
+ ### Model Sources
48
+
49
+ - **Repository:** [Kimargin/GPT-NEO-1.3B-wiki](https://huggingface.co/Kimargin/GPT-NEO-1.3B-wiki)
50
+
51
+ ## Uses
52
+
53
+ ### Direct Use
54
+
55
+ This model can be used for tasks like text generation, summarization, and question-answering. It is useful for generating coherent and factual text based on English-language prompts.
56
+
57
+ ### Downstream Use
58
+
59
+ The model can be fine-tuned further for domain-specific applications such as legal or medical text generation, creating specialized question-answering systems, or generating structured content from prompts.
60
+
61
+ ### Out-of-Scope Use
62
+
63
+ The model should not be used in critical applications (e.g., legal, medical, or financial advice) as it may generate biased, inaccurate, or misleading information. It is also not suited for real-time decision-making.
64
+
65
+ ## Bias, Risks, and Limitations
66
+
67
+ Since the model was trained on Wikipedia data, it may inherit biases present in the dataset. Users should be cautious when using the model for generating sensitive or potentially biased content. The model may produce inaccurate or misleading text if given ambiguous or misleading prompts.
68
+
69
+ ### Recommendations
70
+
71
+ Users should verify the outputs of the model, especially in critical use cases, and should not rely solely on the model for factual accuracy without human verification.
72
+
73
+ ## How to Get Started with the Model
74
+
75
+ To use the model, you can load it as follows:
76
+
77
+
78
+ tokenizer = AutoTokenizer.from_pretrained("Kimargin/GPT-NEO-1.3B-wiki")
79
+ model = AutoModelForCausalLM.from_pretrained("Kimargin/GPT-NEO-1.3B-wiki")
80
+
81
+ input_text = "What happened during World War II?"
82
+ inputs = tokenizer(input_text, return_tensors="pt")
83
+ outputs = model.generate(inputs["input_ids"], max_length=100)
84
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
85
+
86
+
87
+ ## Training Details
88
+
89
+ ### Training Data
90
+ The model was fine-tuned on a subset of the Wikipedia dataset, which contains a broad range of general knowledge topics. This dataset was chosen to improve the model's capability to generate accurate, general-domain knowledge.
91
+
92
+ ### Training Procedure
93
+ The model was fine-tuned using mixed precision (float16) on multiple GPUs for three epochs. The training was done to minimize perplexity and improve fluency in generated text.
94
+
95
+ ### Training Hyperparameters
96
+ - **Learning rate:** 5e-5
97
+ - **Batch size:** 16
98
+ - **Epochs:** 3
99
+ - **Precision:** float16 (mixed precision)
100
+
101
+ ## Evaluation
102
+
103
+ ### Testing Data
104
+ The model was evaluated using a validation subset of the Wikipedia dataset to measure its performance on general text generation tasks.
105
+
106
+ ### Metrics
107
+ - **Perplexity:** The model achieved a perplexity of 25.3 on the validation set.
108
+ - **Accuracy:** The accuracy of the model in generating factual answers was evaluated qualitatively.
109
+
110
+ ### Results
111
+ The model demonstrates good performance in generating coherent and contextually relevant text, but it may still struggle with niche or specialized topics that are underrepresented in its training data.
112
+
113
+ ## Environmental Impact
114
+ Training large models like GPT-Neo has a significant carbon footprint due to the computational resources required. The estimated environmental impact of fine-tuning this model is as follows:
115
+
116
+ - **Hardware Type:** NVIDIA A100 GPUs
117
+ - **Hours used:** 20 hours
118
+ - **Cloud Provider:** Google Cloud
119
+ - **Compute Region:** US-Central
120
+ - **Carbon Emitted:** ~50 kg CO2 (estimated using the [ML Impact calculator](https://mlco2.github.io/impact#compute))
121
+
122
+ ## Technical Specifications
123
+
124
+ ### Model Architecture and Objective
125
+ The model is a causal language model with 1.3 billion parameters, based on the GPT-Neo architecture. It generates text by predicting the next word in a sequence, making it suitable for text completion and generation tasks.
126
+
127
+ ### Compute Infrastructure
128
+ The model was trained on NVIDIA A100 GPUs using Google Cloud infrastructure.
129
+
130
+ ## Citation
131
+
132
+ If you use this model, please cite the original GPT-Neo model as follows:
133
+
134
+ ```bibtex
135
+ @article{gpt-neo,
136
+ author = {EleutherAI},
137
+ title = {GPT-Neo: Large Scale Autoregressive Language Model},
138
+ year = {2021},
139
+ url = {https://github.com/EleutherAI/gpt-neo}
140
+ }
141
+