Irfanuruchi commited on
Commit
6ba3c59
·
verified ·
1 Parent(s): b881000

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +61 -0
README.md ADDED
@@ -0,0 +1,61 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - gpt-2
4
+ - coreml
5
+ - apple
6
+ - ios
7
+ - macos
8
+ - language-model
9
+ - text-generation
10
+ - transformer
11
+ license: mit
12
+ base_model:
13
+ - openai/gpt-2
14
+ ---
15
+
16
+ # GPT-2 Core ML Model
17
+
18
+ [![GitHub Repo](https://img.shields.io/badge/GitHub-Repo-181717?style=for-the-badge&logo=github)](https://github.com/IrfanUruchi/GPT2_CoreML)
19
+ [![Model Weights](https://img.shields.io/badge/🤗-Model_Weights-FFD21F?style=for-the-badge)](https://huggingface.co/Irfanuruchi/GPT-2_Core_ML)
20
+ [![License](https://img.shields.io/badge/License-OpenAI_Model_License-blue.svg?style=for-the-badge)](https://github.com/openai/gpt-2/blob/master/LICENSE)
21
+
22
+ ---
23
+
24
+ This repository contains a version of OpenAI’s GPT-2 language model converted to Core ML format for efficient on-device inference on iOS and macOS.
25
+
26
+ ## Model Details
27
+
28
+ - **Base model:** [OpenAI GPT-2](https://github.com/openai/gpt-2)
29
+ - **Conversion tool:** [coremltools](https://github.com/apple/coremltools)
30
+ - **Format:** Core ML (`.mlmodel`)
31
+ - **Usage:** Runs entirely offline on Apple devices, no data leaves the device.
32
+
33
+ ---
34
+
35
+ ## License
36
+
37
+ The original GPT-2 model is licensed under the [OpenAI Model License]([LICENSE]((https://github.com/openai/gpt-2/blob/master/LICENSE)).
38
+ **Do not use this model for illegal, harmful, or deceptive purposes, as outlined in the license.**
39
+
40
+ ---
41
+
42
+ ## Attribution
43
+
44
+ - Convertion tools by Apple [coremltools](https://github.com/apple/coremltools)
45
+ - GPT-2 by OpenAI ([GitHub](https://github.com/openai/gpt-2))
46
+ - Core ML conversion by Irfan
47
+
48
+ ---
49
+
50
+ ## Limitations and considerations
51
+
52
+ - The model may generate biased or inappropriate content reflecting its training data.
53
+ - Performance and output may differ slightly from the original GPT-2 due to conversion and optimization.
54
+ - Intended for research, experimentation, and on-device applications on Apple platforms.
55
+ - Not suitable for high-stakes or sensitive use cases without additional safeguards.
56
+
57
+ ---
58
+
59
+ ## Contribution and feedback
60
+
61
+ Contributions, issues, and feature requests are welcome! Feel free to open a GitHub issue or pull request.