muhammad-fiaz commited on
Commit
dde4d03
1 Parent(s): 6a55326

initial commit

Browse files
Files changed (13) hide show
  1. .env +1 -0
  2. .github/CODEOWNERS +1 -0
  3. .github/FUNDING.yml +3 -0
  4. .gitignore +5 -0
  5. CITATION.cff +9 -0
  6. CODE_OF_CONDUCT.md +128 -0
  7. LICENSE +201 -0
  8. README.md +115 -13
  9. launch.py +7 -0
  10. modules/log.py +14 -0
  11. modules/pipeline.py +47 -0
  12. requirements.txt +5 -0
  13. webui.py +66 -0
.env ADDED
@@ -0,0 +1 @@
 
 
1
+ LICENSE="Apache-2.0"
.github/CODEOWNERS ADDED
@@ -0,0 +1 @@
 
 
1
+ *@muhammad-fiaz
.github/FUNDING.yml ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ # These are supported funding model platforms
2
+
3
+ github: muhammad-fiaz
.gitignore ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ .venv
2
+ .idea/
3
+ *.xml
4
+ *.iml
5
+ /log.txt
CITATION.cff ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ cff-version: 1.2.0
2
+ message: "If you use this software, please cite it as below."
3
+ title: "GemGPT"
4
+ authors:
5
+ - name: "Muhammad Fiaz"
6
+ version: 0.0.0
7
+ date-released: 2024-03-25
8
+ license: "Apache-2.0"
9
+ url: "https://github.com/muhammad-fiaz/GemGPT"
CODE_OF_CONDUCT.md ADDED
@@ -0,0 +1,128 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ .
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
+ https://www.contributor-covenant.org/translations.
LICENSE ADDED
@@ -0,0 +1,201 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
README.md CHANGED
@@ -1,13 +1,115 @@
1
- ---
2
- title: GemGPT
3
- emoji: 🔥
4
- colorFrom: blue
5
- colorTo: red
6
- sdk: gradio
7
- sdk_version: 4.24.0
8
- app_file: app.py
9
- pinned: false
10
- license: apache-2.0
11
- ---
12
-
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <div style="text-align: center;">
2
+
3
+ ![Preview ](https://github.com/muhammad-fiaz/GemGPT/assets/75434191/9c6566ca-db7f-49e2-9ddd-0781edea042f)
4
+
5
+ [![License](https://img.shields.io/github/license/muhammad-fiaz/gemgpt)](./LICENSE)
6
+ [![Version](https://img.shields.io/github/v/release/muhammad-fiaz/gemgpt)](https://github.com/muhammad-fiaz/gemgpt/releases)
7
+ [![Code Size](https://img.shields.io/github/languages/code-size/muhammad-fiaz/gemgpt)](https://github.com/muhammad-fiaz/gemgpt)
8
+ [![Top Language](https://img.shields.io/github/languages/top/muhammad-fiaz/gemgpt)](https://github.com/muhammad-fiaz/gemgpt)
9
+ [![Last Commit](https://img.shields.io/github/last-commit/muhammad-fiaz/gemgpt)](https://github.com/muhammad-fiaz/gemgpt/commits/main)
10
+ [![Contributors](https://img.shields.io/github/contributors/muhammad-fiaz/gemgpt)](https://github.com/muhammad-fiaz/gemgpt/graphs/contributors)
11
+ [![Open Issues](https://img.shields.io/github/issues-raw/muhammad-fiaz/gemgpt)](https://github.com/muhammad-fiaz/gemgpt/issues)
12
+ [![Closed Issues](https://img.shields.io/github/issues-closed-raw/muhammad-fiaz/gemgpt)](https://github.com/muhammad-fiaz/gemgpt/issues?q=is%3Aissue+is%3Aclosed)
13
+ [![Pull Requests](https://img.shields.io/github/issues-pr-raw/muhammad-fiaz/gemgpt)](https://github.com/muhammad-fiaz/gemgpt/pulls)
14
+ [![Forks](https://img.shields.io/github/forks/muhammad-fiaz/gemgpt?style=social)](https://github.com/muhammad-fiaz/gemgpt/network/members)
15
+ [![Stars](https://img.shields.io/github/stars/muhammad-fiaz/gemgpt?style=social)](https://github.com/muhammad-fiaz/gemgpt/stargazers)
16
+ [![Watchers](https://img.shields.io/github/watchers/muhammad-fiaz/gemgpt?style=social)](https://github.com/muhammad-fiaz/gemgpt/watchers)
17
+
18
+ </div>
19
+
20
+ GemGPT is a project that leverages the Gemma model published by Google to create powerful natural language processing applications using the GPT architecture. This repository contains the codebase for GemGPT, which aims to provide a user-friendly interface for fine-tuning the Gemma model for 2b and 7b variants.
21
+
22
+ > Don't forget to star ⭐ and fork 🍴 the repository if you find GemGPT useful!
23
+
24
+ ## Table of Contents
25
+
26
+ 1. [Overview](#)
27
+ 2. [Features](#features)
28
+ 3. [Getting Started](#getting-started)
29
+ 4. [Technology Stack](#technology-stack)
30
+ 5. [Contributing](#contributing)
31
+ 6. [Code of Conduct](#code-of-conduct)
32
+ 7. [Support](#support)
33
+ 8. [Acknowledgements](#acknowledgements)
34
+ 9. [License](#license)
35
+
36
+ ## Features
37
+
38
+ - Utilizes the Gemma model for natural language processing tasks.
39
+ - Provides an easy-to-use interface for integrating Gemma with AI applications.
40
+ - Offers advanced features for text generation, sentiment analysis, and more.
41
+
42
+ ## Getting Started
43
+
44
+ To get started with GemGPT, clone the repository and follow the setup instructions in the documentation.
45
+
46
+ ```shell
47
+ git clone https://github.com/muhammad-fiaz/gemgpt.git
48
+ ```
49
+ Navigate to the project directory and install the required dependencies:
50
+
51
+ ```shell
52
+ cd gemgpt
53
+ pip install -r requirements.txt
54
+ ```
55
+ Run the application using the following command:
56
+
57
+ ```shell
58
+ python launch.py
59
+ ```
60
+ To use GemGpt on Colab or Jupyter Notebook, you can use the following code:
61
+
62
+ ```bash
63
+ !git clone https://github.com/muhammad-fiaz/gemgpt.git
64
+ !python -m pip install -r requirements.txt
65
+ !python launch.py --share
66
+ ```
67
+
68
+
69
+ ## Technology Stack
70
+
71
+ GemGPT is built using the following technologies:
72
+
73
+ - **Python**: Programming language used for the core implementation.
74
+ - **PyTorch**: Deep learning framework used for training and inference.
75
+ - **Gradio**: Web-based UI library used for creating the user interface.
76
+ - **Transformers**: Library used for working with pre-trained language models.
77
+ - **Hugging Face**: Platform used for sharing and downloading pre-trained models.
78
+ - **Logly**: Logging library used for tracking and monitoring the application.
79
+
80
+
81
+ ## Contributing
82
+
83
+ We welcome contributions from the community to improve GemGPT. If you're interested in contributing, please read our contributing guidelines.
84
+
85
+ ## CODE OF CONDUCT
86
+
87
+ We expect contributors to adhere to the GemGPT code of conduct. Please read the [code of conduct](./CODE_OF_CONDUCT.md) before contributing.
88
+
89
+ ## Support
90
+
91
+ If you have any questions or need help with GemGPT, please reach out to us via the issue tracker.
92
+
93
+ _Support the Project by Becoming a Sponsor on GitHub_
94
+
95
+ [![Sponsor muhammad-fiaz](https://img.shields.io/badge/Sponsor-%231EAEDB.svg?&style=for-the-badge&logo=GitHub-Sponsors&logoColor=white)](https://github.com/sponsors/muhammad-fiaz)
96
+
97
+ ## Acknowledgements
98
+
99
+ GemGPT is built on top of the Gemma model published by Google. We would like to thank the authors of the Gemma model for their work and for making it available to the public.
100
+
101
+ ## License
102
+
103
+ GemGPT is licensed under the Apache License 2.0. See the [LICENSE](./LICENSE) file for more details.
104
+
105
+ ```bibtex
106
+ @software{Muhammad_Fiaz_GemGPT_2024,
107
+ author = {{Muhammad Fiaz}},
108
+ license = {Apache-2.0},
109
+ month = mar,
110
+ title = {{GemGPT}},
111
+ url = {https://github.com/muhammad-fiaz/GemGPT},
112
+ version = {0.0.0},
113
+ year = {2024}
114
+ }
115
+
launch.py ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ import sys
2
+ from webui import app
3
+
4
+ if "--share" in sys.argv:
5
+ app.launch(share=True)
6
+ else:
7
+ app.launch()
modules/log.py ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Import Logly
2
+ import os
3
+
4
+ from logly import Logly
5
+
6
+ logly = Logly()
7
+
8
+ # Set the default file path and maximum file size
9
+ logly.set_default_max_file_size(50)
10
+ logger = os.path.join(os.path.dirname(os.path.abspath(__file__)), "../log.txt")
11
+ logly.set_default_file_path(logger)
12
+
13
+
14
+ logly.start_logging()
modules/pipeline.py ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import os
2
+
3
+ from modules.log import logly
4
+
5
+ os.environ["TF_ENABLE_ONEDNN_OPTS"] = "0"
6
+ import torch
7
+ from transformers import pipeline, AutoTokenizer, BitsAndBytesConfig
8
+
9
+
10
+ def pipeline_tunnel(model, device):
11
+ return pipeline(
12
+ "text-generation",
13
+ model=model,
14
+ model_kwargs={
15
+ "torch_dtype": torch.float16,
16
+ },
17
+ device=device,
18
+ )
19
+
20
+
21
+ def chatbot(input_text, max_new_tokens=1250, temperature=0.7, top_k=50, top_p=0.95, model="google/gemma-2b-it",
22
+ quantization="4-bit", device="cuda"):
23
+ try:
24
+ if quantization == "4-bit":
25
+ quantization_config = BitsAndBytesConfig(load_in_4bit=True)
26
+
27
+ else:
28
+ quantization_config = BitsAndBytesConfig(load_in_8bit=True)
29
+
30
+ tokenizer = AutoTokenizer.from_pretrained(model, quantization_config=quantization_config)
31
+
32
+ pipeline_model = pipeline_tunnel(model, device)
33
+ messages = [{"role": "user", "content": input_text}]
34
+ prompt = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
35
+ outputs = pipeline_model(
36
+ prompt,
37
+ max_new_tokens=max_new_tokens,
38
+ do_sample=True,
39
+ temperature=temperature,
40
+ top_k=top_k,
41
+ top_p=top_p
42
+ )
43
+ generated_text = outputs[0]["generated_text"][len(prompt):]
44
+ return generated_text
45
+ except Exception as e:
46
+ logly.error(f"Error in GemGPT: {e}")
47
+ return str(e)
requirements.txt ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ torch~=2.2.1+cu121
2
+ transformers~=4.38.1
3
+ gradio~=4.24.0
4
+ accelerate~=0.28.0
5
+ logly~=0.0.6
webui.py ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import torch
2
+
3
+ from modules.log import logly
4
+ from modules.pipeline import chatbot
5
+
6
+ import gradio as gr
7
+
8
+ if torch.cuda.is_available():
9
+ device = "cuda"
10
+ logly.info("CUDA is available and using GPU instead.")
11
+ else:
12
+ device = "cpu"
13
+ logly.info("CUDA is not available and using CPU instead.")
14
+
15
+ with gr.Blocks(theme=gr.themes.Soft(), title="GemGPT") as app:#head="<link rel='icon' href='' sizes='32x32' />"
16
+ gr.HTML("<link rel='icon' href='https://gemmamodels.com/wp-content/uploads/2021/10/cropped-gem-32x32.png' sizes='32x32' />")
17
+ gr.HTML("<h1 style='text-align: center;'>GemGPT</h1>")
18
+ gr.HTML("<h3 style='text-align: center;'>Talk to GemGPT, Powered by Gemma Models</h3>")
19
+ with gr.Row():
20
+ gr.Markdown("Select a model to run. Gemma-2b-it is a smaller model that is faster and uses less memory. Gemma-7b-it is a larger model that is slower and uses more memory.")
21
+ model_options = gr.Dropdown(label="Select a Model", choices=["google/gemma-2b-it", "google/gemma-7b-it"],
22
+ value="google/gemma-2b-it")
23
+ with gr.Row():
24
+ gr.Markdown("Select the device to run the model on. If you are running this on a CPU, select CPU. If you are running this on a GPU, select CUDA.")
25
+ device = gr.Dropdown(label="Device", choices=["cuda", "cpu"], value=device)
26
+ with gr.Row():
27
+ gr.Markdown("Output Generated by Selected Model:")
28
+ with gr.Row():
29
+ outputs = gr.Textbox(lines=15, label="Output", value="")
30
+ with gr.Row():
31
+ gr.Markdown("Input your Prompt and click Generate to get a response.")
32
+ with gr.Row():
33
+ inputs = gr.Textbox(lines=2, label="Prompt", placeholder="Type here")
34
+ with gr.Row():
35
+ generate = gr.Button("Generate")
36
+ with gr.Row():
37
+ advanced_checkbox = gr.Checkbox(label="Show Advanced Options", container=False, elem_classes='min_check',
38
+ value=False)
39
+
40
+ with gr.Column(scale=1,visible=False) as advanced_column:
41
+ with gr.Row():
42
+ gr.Markdown("<h4>Adjust the parameters to control the model's output.</h4>")
43
+ with gr.Row():
44
+ gr.Markdown("Max New Tokens is the maximum number of tokens that the model will generate.")
45
+ with gr.Row():
46
+ tokens = gr.Slider(minimum=50, maximum=2000, label="Max New Tokens", value=1250)
47
+ with gr.Row():
48
+ gr.Markdown("Temperature is a parameter that controls the randomness of the model's output. A higher temperature will produce more random output.")
49
+ with gr.Row():
50
+ temp = gr.Slider(minimum=0.0, maximum=1.0, label="Temperature", value=0.7)
51
+ with gr.Row():
52
+ gr.Markdown("Top K is a parameter that controls the diversity of the model's output. A higher value will produce more diverse output.")
53
+ with gr.Row():
54
+ top_k = gr.Slider(minimum=1, maximum=100, label="Top K", value=50)
55
+ with gr.Row():
56
+ gr.Markdown("Top P is an alternative to Top K that selects the smallest set of tokens whose cumulative probability exceeds the threshold P.")
57
+ with gr.Row():
58
+ top_p = gr.Slider(minimum=0.0, maximum=1.0, label="Top P", value=0.95)
59
+ with gr.Row():
60
+ gr.Markdown("Quantization is a technique to reduce the size of the model and speed up inference. 4-bit quantization is faster but less accurate than 8-bit.")
61
+ with gr.Row():
62
+ quantization = gr.Dropdown(label="Quantization", choices=["8-bit", "4-bit"], value="4-bit")
63
+ generate.click(fn=chatbot, inputs=[inputs, tokens, temp, top_k, top_p, model_options,quantization,device], outputs=outputs)
64
+
65
+ advanced_checkbox.change(lambda x: gr.update(visible=x), advanced_checkbox, advanced_column,
66
+ queue=False, show_progress=False)