kzorluoglu commited on
Commit
252d8e9
verified
1 Parent(s): 716a2ba

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +582 -174
README.md CHANGED
@@ -1,202 +1,610 @@
1
  ---
2
- base_model: unsloth/gemma-2-9b-bnb-4bit
3
- library_name: peft
 
 
 
 
 
 
 
 
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
- <!-- Provide a longer summary of what this model is. -->
17
-
18
-
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
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
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
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
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
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
- Use the code below to get started with the model.
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
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
 
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
 
127
  ### Results
128
-
129
- [More Information Needed]
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
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
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
- - **Hardware Type:** [More Information Needed]
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
- [More Information Needed]
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
- ### Framework versions
201
 
202
- - PEFT 0.13.2
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ base_model:
6
+ - unsloth/gemma-2-9b-bnb-4bit
7
+ pipeline_tag: question-answering
8
+ tags:
9
+ - chameleon
10
+ - shop
11
+ - esono
12
  ---
13
+ # Chameleon-Code_Explation_Gemma29b-v3
14
+
15
+ Chameleon-Code_Explation_Gemma29b-v3 is a fine-tuned version of the Unsloth Gemma model, optimized for efficient inference using 4-bit quantization. This model has been trained to explain various classes within the Chameleon CMS system, which is a combined shop software and content management system.
16
+
17
+ ## Table of Contents
18
+ - [Model Overview](#model-overview)
19
+ - [Getting Started](#getting-started)
20
+ - [Available Classes](#available-classes)
21
+ - [Training Details](#training-details)
22
+ - [Evaluation](#evaluation)
23
+ - [Environmental Impact](#environmental-impact)
24
+ - [Technical Specifications](#technical-specifications)
25
+ - [Contact](#contact)
26
+
27
+ ## Model Overview
28
+
29
+ Chameleon-Code_Explation_Gemma29b-v3 is a transformer-based language model fine-tuned to understand and explain the structure and components of the Chameleon CMS system. The model can provide non-technical descriptions of CMS components using efficient 4-bit quantization to minimize resource requirements.
30
+
31
+ - **Base Model:** Google Gemma 2 9B
32
+ - **Library Used:** PEFT
33
+ - **Language:** English
34
+ - **License:** Apache 2.0
35
+ - **Developer:** kzorluoglu
36
+ - **Model Source:** [Unsloth GitHub](https://github.com/unslothai/unsloth)
37
+
38
+ ## Getting Started
39
+
40
+ To use the model, you can start by installing the necessary dependencies and downloading the model using the Hugging Face Transformers library.
41
+
42
+ ### Installation
43
+
44
+ Install the `transformers` library:
45
+
46
+ ```sh
47
+ pip install transformers
48
+ ```
49
+
50
+ ### Usage
51
+
52
+ Here is an example code snippet to get started:
53
+
54
+ ```python
55
+ from transformers import AutoModel, AutoTokenizer
56
+
57
+ model = AutoModel.from_pretrained("kzorluoglu/Chameleon-Code_Explation_Gemma29b-v2")
58
+ tokenizer = AutoTokenizer.from_pretrained("kzorluoglu/Chameleon-Code_Explation_Gemma29b-v2")
59
+
60
+ print("Chatbot is ready!")
61
+ print("Type 'exit' to end the chat.")
62
+ print("Ask like this for a good answer:")
63
+ print("Explain the XYZ class. I don't want to see code, I want only the explanation.")
64
+ print("Explain the ABC bundle. I don't want to see code, I want only the explanation.")
65
+
66
+ while True:
67
+ question = input("You: ")
68
+ if question.lower() == 'exit':
69
+ print("Ending the chat. Goodbye!")
70
+ break
71
+
72
+ instruction = f"{question}"
73
+ inputs = tokenizer([instruction], return_tensors="pt").to("cuda")
74
+ outputs = model.generate(**inputs, max_new_tokens=256, use_cache=True)
75
+ generated_text = tokenizer.batch_decode(outputs, skip_special_tokens=True)
76
+ print(f"AI: {generated_text[0]}")
77
+ ```
78
+
79
+ ## Available Bundles
80
+
81
+ In addition to individual classes, the model has also been trained to explain a wide range of bundles within the Chameleon CMS system, including but not limited to:
82
+ * AmazonPaymentBundle
83
+ * ShopOrderStatusBundle
84
+ * ShopWishlistBundle
85
+ * ImageHotspotBundle
86
+ * ShopArticlePreorderBundle
87
+ * ShopCurrencyBundle
88
+ * ShopPaymentIPNBundle
89
+ * ShopAffiliateBundle
90
+ * ShopBundle
91
+ * ShopRatingServiceBundle
92
+ * SearchBundle
93
+ * ShopArticleReviewBundle
94
+ * ShopListFilterBundle
95
+ * ShopPaymentTransactionBundle
96
+ * ShopArticleDetailPagingBundle
97
+ * CmsEventBundle
98
+ * MediaManagerBundle
99
+ * ViewRendererBundle
100
+ * CmsCounterBundle
101
+ * UpdateCounterMigrationBundle
102
+ * CmsStringUtilitiesBundle
103
+ * ExternalTrackerBundle
104
+ * CookieConsentBundle
105
+ * CmsResultCacheBundle
106
+ * CmsActionPluginBundle
107
+ * CmsClassManagerBundle
108
+ * PkgCoreBundle
109
+ * ExtranetBundle
110
+ * CoreBundle
111
+ * CmsNavigationBundle
112
+ * JavaScriptMinificationBundle
113
+ * TrackViewsBundle
114
+ * CmsTextFieldBundle
115
+ * CmsCacheBundle
116
+ * AutoclassesBundle
117
+ * CmsChangeLogBundle
118
+ * DatabaseMigrationBundle
119
+ * Csv2SqlBundle
120
+ * NewsletterBundle
121
+ * DistributionBundle
122
+ * CmsFileManagerBundle
123
+ * SecurityBundle
124
+ * SnippetRendererBundle
125
+ * AtomicLockBundle
126
+ * TwigDebugBundle
127
+
128
+ ## Available Classes
129
+
130
+ The model has been trained to provide explanations for a wide range of classes in the Chameleon CMS system, including but not limited to:
131
+
132
+ * MTFeedbackErrors
133
+ * AmazonDataConverter
134
+ * AmazonPaymentConfigFactory
135
+ * AmazonReferenceIdManager
136
+ * WebServerExample
137
+ * OffAmazonPaymentsNotifications_Samples_NotificationSample
138
+ * OffAmazonPaymentsNotifications_Samples_IpnLogFile
139
+ * SnsMessageValidator
140
+ * IpnNotificationParser
141
+ * XmlNotificationParser
142
+ * Message
143
+ * SnsMessageParser
144
+ * OffAmazonPayments_Model
145
+ * OffAmazonPaymentsService_Model
146
+ * OffAmazonPaymentsService_Regions
147
+ * OffAmazonPaymentsService_RegionSpecificProperties
148
+ * OffAmazonPaymentsService_Environments
149
+ * OffAmazonPaymentsService_MerchantValues
150
+ * OffAmazonPaymentsService_Model_ResponseHeaderMetadata
151
+ * CancellationExample
152
+ * CLIExample
153
+ * SimpleCheckoutExample
154
+ * AddressConsentSample
155
+ * SplitShipmentsCheckoutExample
156
+ * RefundExample
157
+ * AutomaticPaymentsSimpleCheckoutExample
158
+ * ShippingAndTaxCostHelper
159
+ * CountryRates
160
+ * AmazonPaymentFixturesFactory
161
+ * ConfigValidator
162
+ * AmazonPaymentIdMapping
163
+ * TPkgShopOrderStatusManagerEndPoint
164
+ * PkgShopWishlistMailHistory
165
+ * PkgShopWishlistArticle
166
+ * PkgShopWishlistOrderItem
167
+ * PkgShopWishlist
168
+ * PkgImageHotspotItemMarker
169
+ * PkgImageHotspot
170
+ * PkgImageHotspotItemSpot
171
+ * PkgImageHotspotItem
172
+ * UpdateProductStockListener
173
+ * ShopCurrencyEvents
174
+ * TPkgShopPaymentIPNManager
175
+ * TPkgShopPaymentIPNRequest
176
+ * TPkgShopPaymentIPN_TransactionDetails
177
+ * PkgShopPaymentIpnMessage
178
+ * PkgShopPaymentIpnTrigger
179
+ * PkgShopPaymentIpnStatus
180
+ * PkgShopPaymentIpnMessageTrigger
181
+ * PkgShopAffiliate
182
+ * PkgShopAffiliateParameter
183
+ * ShopEvents
184
+ * TShopCategoryTree
185
+ * MTShopArticleListResponse
186
+ * TShopBreadcrumbItem
187
+ * TShopBasketArticleCustomDataValidationError
188
+ * TdbShopArticle
189
+ * ShopPaymentHandlerMock
190
+ * BasketVariableReplacer
191
+ * UpdateProductStatisticsListener
192
+ * UpdateVariantParentStockListener
193
+ * UpdateProductStockListener
194
+ * OrderPaymentInfo
195
+ * ShopPaymentConfigRawValue
196
+ * ShopSystemPage
197
+ * PkgShopArticlePreorder
198
+ * Shop
199
+ * ShopShippingGroupHandler
200
+ * ShopShippingGroup
201
+ * ShopWrappingCard
202
+ * ShopCategoryTab
203
+ * PkgShopListfilterItem
204
+ * PkgShopStatisticGroup
205
+ * ShopVat
206
+ * PkgShopFooterCategory
207
+ * PkgShopListfilterModuleConfig
208
+ * ShopSuggestArticleLog
209
+ * ShopBankAccount
210
+ * ShopCategory
211
+ * ShopDiscount
212
+ * PkgShopPrimaryNavi
213
+ * ShopShippingType
214
+ * ShopWrapping
215
+ * PkgShopListfilterItemType
216
+ * PkgShopCurrency
217
+ * PkgShopListfilter
218
+ * ShopUserNoticeList
219
+ * ShopSystemInfoModuleConfig
220
+ * PkgShopArticleReviewModuleShopArticleReviewConfiguration
221
+ * ShopSystemInfo
222
+ * ShopPaymentHandlerGroup
223
+ * ShopPaymentMethod
224
+ * ShopPaymentHandlerGroupConfig
225
+ * ShopPaymentHandler
226
+ * ShopPaymentHandlerParameter
227
+ * ShopArticleCatalogConfDefaultOrder
228
+ * ShopStockMessageTrigger
229
+ * ShopVariantType
230
+ * ShopArticleImageSize
231
+ * ShopAttribute
232
+ * ShopBundleArticle
233
+ * ShopArticleDocumentType
234
+ * ShopArticleMarker
235
+ * ShopArticle
236
+ * ShopArticleImage
237
+ * ShopArticleReview
238
+ * ShopArticleCatalogConf
239
+ * ShopArticleContributor
240
+ * ShopArticleDocument
241
+ * ShopVariantSet
242
+ * ShopStockMessage
243
+ * ShopArticleType
244
+ * ShopVariantDisplayHandler
245
+ * ShopUnitOfMeasurement
246
+ * ShopArticleStats
247
+ * ShopAttributeValue
248
+ * ShopVariantTypeHandler
249
+ * ShopContributorType
250
+ * ShopContributor
251
+ * ShopVariantTypeValue
252
+ * ShopManufacturerModuleConf
253
+ * ShopArticleStock
254
+ * ShopArticlePreviewImage
255
+ * ShopManufacturer
256
+ * ShopArticleGroup
257
+ * ShopVoucherUse
258
+ * ShopVoucherSeriesSponsor
259
+ * ShopUserPurchasedVoucher
260
+ * ShopVoucherSeries
261
+ * ShopVoucher
262
+ * ShopModuleArticleListArticle
263
+ * ShopModuleArticlelistOrderby
264
+ * ShopModuleArticleList
265
+ * ShopModuleArticleListFilter
266
+ * ShopOrderBasket
267
+ * ShopOrder
268
+ * ShopOrderStatusCode
269
+ * ShopOrderExportLog
270
+ * ShopOrderStatusItem
271
+ * ShopOrderStatus
272
+ * ShopOrderVat
273
+ * ShopOrderShippingGroupParameter
274
+ * ShopOrderItem
275
+ * ShopOrderStep
276
+ * ShopOrderBundleArticle
277
+ * ShopOrderPaymentMethodParameter
278
+ * ShopOrderDiscount
279
+ * SearchSuggestController
280
+ * XmlStreamer
281
+ * TShopAuskunftAPI
282
+ * PkgShopRatingServiceRating
283
+ * PkgShopRatingServiceTeaserCnf
284
+ * PkgShopRatingServiceWidgetConfig
285
+ * PkgShopRatingServiceHistory
286
+ * PkgShopRatingService
287
+ * TShopModuleArticleListFilterAutoParent
288
+ * TdbShopModuleArticleListFilter
289
+ * SearchResultTriggerCmsObserverListener
290
+ * SearchResultLoggerListener
291
+ * ShopSearchFieldWeight
292
+ * ShopSearchCloudWord
293
+ * ShopSearchCache
294
+ * ShopSearchQuery
295
+ * ShopSearchCacheItem
296
+ * ShopSearchIndexer
297
+ * ShopSearchKeywordArticle
298
+ * ShopSearchLog
299
+ * ShopSearchIgnoreWord
300
+ * AuthorDisplayConstants
301
+ * Slider
302
+ * Select
303
+ * DbAdapter
304
+ * TPkgShopPaymentTransactionItemDataEndPoint
305
+ * TPkgShopPaymentTransactionManagerEndPoint
306
+ * TPkgShopPaymentTransactionContextEndPoint
307
+ * PkgShopPaymentTransactionPosition
308
+ * PkgShopPaymentTransactionType
309
+ * PkgShopPaymentTransaction
310
+ * AddParametersToUrlService
311
+ * CacheUtil
312
+ * TPkgCmsEventManager
313
+ * DeleteMediaConnectionsListener
314
+ * ViewRenderer
315
+ * TPkgViewRendererMapper_ListHandlerData
316
+ * TPkgViewRendererLessCompiler
317
+ * TPkgViewRendererSnippetResourceCollectorEndPoint
318
+ * TPkgViewRendererSnippetDummyData
319
+ * TPkgViewRendererSnippetGalleryItem
320
+ * MapperVirtualSourceObject
321
+ * User
322
+ * Article
323
+ * GenerateCssController
324
+ * CmsCounter
325
+ * UpdateCounterMigrator
326
+ * UpdateCounterVersionMigrator
327
+ * MigrationConfigGenerator
328
+ * MigrateCountersListener
329
+ * TPkgCmsStringUtilities_HTML
330
+ * TPkgCmsStringUtilities_ReadConfig
331
+ * TPkgCmsStringUtilities_CleanPHPCode
332
+ * TPkgCmsStringUtilities_iOSMailURLEncoder
333
+ * TPkgCmsStringUtilities_PathUtils
334
+ * SearchResultTriggerCmsObserverListener
335
+ * CategoryTriggerCmsObserverListener
336
+ * AddCookieConsentIncludesListener
337
+ * TPkgCmsResultCacheManager
338
+ * TPkgCmsActionPluginManager
339
+ * AbstractPkgActionPlugin
340
+ * TPkgCmsVirtualClassManager
341
+ * TPkgCmsCoreSendToHost
342
+ * TPkgCoreUtility_Network
343
+ * TPkgCmsCoreLayoutPluginManager
344
+ * TPkgCmsCoreParameterContainerParameterDefinition
345
+ * AbstractPkgCmsCoreParameterContainer
346
+ * ExtranetEvents
347
+ * ExtranetUserConstants
348
+ * RefreshAuthenticityTokenListener
349
+ * RehashPasswordListener
350
+ * DelayFailedLoginAttemptListener
351
+ * LoginByTokenController
352
+ * ServiceLocator
353
+ * CoreEvents
354
+ * CronJobScheduleDataModel
355
+ * chameleon
356
+ * TableConfigurationDataModel
357
+ * CmsMasterPagdef
358
+ * DownloadLinkDataModel
359
+ * PagePath
360
+ * File
361
+ * Error
362
+ * UploaderController
363
+ * UploaderParametersDataModel
364
+ * UploadedFileDataModel
365
+ * StripVirtualFieldsFromQuery
366
+ * CronJobThatDoesNotExtendTCMSCronJob
367
+ * HtmlHelper
368
+ * TGlobalBase
369
+ * TModuleLoader
370
+ * TModelBase
371
+ * MTCustomListCoreConfig
372
+ * TTemplateTools
373
+ * TCMRenderMediaTreeSelectBox
374
+ * TCMSRegistry
375
+ * TCMSSmartURL
376
+ * TCMSTidyHTMLCleaner
377
+ * TCMSLockManager
378
+ * TCMSURLHistory
379
+ * TCMSRssHandler
380
+ * TCMSRender
381
+ * TPkgDependencyInjection
382
+ * TCMSLogChange
383
+ * TCMSViewPortManager
384
+ * TCMSRenderSeoPattern
385
+ * TCMSPageDefinitionFile
386
+ * TCMSRenderDocumentTreeSelectBox
387
+ * FalseValueCacheEntry
388
+ * TCMSMemcache
389
+ * TCMSTreeWidget
390
+ * TCMSTableToClass_MockRecord
391
+ * TCMSTableToClass
392
+ * TCacheManagerRuntimeCache
393
+ * TViewParser
394
+ * TCMSSmartURLData
395
+ * TCMSSmartURLHandler
396
+ * TCMSParameterMapperEndPoint
397
+ * TCMSMenuItem
398
+ * TCMSSpellcheck
399
+ * MTFeedbackErrorsCore
400
+ * TCMSErrorHandler
401
+ * MySqlLegacySupport
402
+ * TCMSFile
403
+ * TDbChangeLogManagerForModules
404
+ * TCMSTableEditorManager
405
+ * TCMSTableEditorEndPoint
406
+ * TCMSTableEditorMenuItem
407
+ * TCMSMessageManager
408
+ * TCMSImageEndpoint
409
+ * THTMLTable
410
+ * THTMLTableColumn
411
+ * HtmlParser
412
+ * TGoogleMapMarker
413
+ * TGoogleOverviewMap
414
+ * TGoogleMapEndPoint
415
+ * TGoogleMapIcon
416
+ * TCMSBreadcrumbNavi
417
+ * TCMSBreadcrumbNaviItem
418
+ * TGroupTableField
419
+ * TGroupTable
420
+ * TGroupTableStyle
421
+ * TPkgRunFrontendActionStatus
422
+ * TCMSGroupedStatistics
423
+ * TCMSGroupedStatisticsGroup
424
+ * TCCustomNavigation
425
+ * SQLParser
426
+ * SQLParenthesesParser
427
+ * imageMagick
428
+ * antiSpam
429
+ * TPkgCmsSessionWakeUpService
430
+ * TCMSListManagerEndPoint
431
+ * TCMSUserInput
432
+ * TCMSUserInputFilter_BaseClass
433
+ * TCMSUpdateManager
434
+ * TTools
435
+ * CheckPortalDomainListener
436
+ * CaseInsensitivePortalExceptionListener
437
+ * TemplateEngineAccessListener
438
+ * AddAntispamIncludesListener
439
+ * BackendBreadcrumbListener
440
+ * AddControllerIncludesListener
441
+ * CleanupBreadcrumbAfterDeleteListener
442
+ * RedirectToSecurePageListener
443
+ * ClearRoutingCacheListener
444
+ * InitializeRequestListener
445
+ * ReleaseOldLocksOnLoginListener
446
+ * AddGlobalHeadIncludesListener
447
+ * MigrateSessionListener
448
+ * AddModuleIncludesListener
449
+ * ChangeChameleonObjectsLocaleListener
450
+ * AddBackendToasterMessageListener
451
+ * NoCacheForSecurePageListener
452
+ * RehashBackendUserPasswordListener
453
+ * AllowEmbeddingForDifferentDomainListener
454
+ * AddJqueryIncludeListener
455
+ * BackendTreeNodeFactory
456
+ * RequestInitializer
457
+ * FieldTranslationUtil
458
+ * UrlUtil
459
+ * MltFieldUtil
460
+ * UrlNormalizationUtil
461
+ * AbstractDatabaseAccessLayer
462
+ * TranslationConstants
463
+ * JsTranslationController
464
+ * ModuleIconMigrator
465
+ * MainMenuMigrator
466
+ * IconMapping
467
+ * MenuItem
468
+ * MenuCategory
469
+ * ChameleonControllerEvents
470
+ * ImageNotFoundController
471
+ * BackendAccessCheck
472
+ * CsrfTokenManagerFactory
473
+ * Migrator
474
+ * ComposerData
475
+ * ComposerJsonModifier
476
+ * AbstractPkgCmsNavigationNode
477
+ * JavaScriptMinifyEventListener
478
+ * ImageCropPresetDataModel
479
+ * ImageCropDataModel
480
+ * ImageDataModel
481
+ * CmsMediaDataModel
482
+ * TPkgTrackObjectViews
483
+ * TrackViewsListener
484
+ * TCMSTextFieldEndPoint
485
+ * TdbCmsLanguage
486
+ * RequestListener
487
+ * AutoClassLoader
488
+ * MappingDataModel
489
+ * DataModelParts
490
+ * name
491
+ * MediaItemChainUsageFinder
492
+ * SortColumnCollection
493
+ * MediaItemUsageChainDeleteService
494
+ * MediaManagerExtensionCollection
495
+ * MediaManagerListResult
496
+ * MediaManagerListRequest
497
+ * AccessRightsModel
498
+ * MediaManagerListState
499
+ * MediaTreeDataModel
500
+ * MediaItemUsageDataModel
501
+ * MediaTreeNodeDataModel
502
+ * MediaItemDataModel
503
+ * JavascriptPluginRenderedContent
504
+ * JavascriptPluginMessage
505
+ * JavascriptPluginConfigurationState
506
+ * JavascriptPluginConfigurationUrls
507
+ * JavascriptPluginConfiguration
508
+ * MediaTreeNodeJsonObject
509
+ * TCMSChangeLogArchiver
510
+ * TCMSChangeLogFormatter
511
+ * SnippetChainModifier
512
+ * MigrationRecorderStateHandler
513
+ * MigrationRecorder
514
+ * QueryWriter
515
+ * DataModelConverter
516
+ * TPkgCsv2SqlManager
517
+ * NewsletterPostProcessorListener
518
+ * NewsletterUserDataModel
519
+ * PostUpdateVersionCheck
520
+ * ChameleonVersion
521
+ * MatchLevel
522
+ * InitialBackendUserCreator
523
+ * TPkgCmsFileManager_Utilities
524
+ * RedirectOnPendingUpdatesEventListener
525
+ * SecurityHelperAccess
526
+ * CmsUserRoleConstants
527
+ * CmsPermissionAttributeConstants
528
+ * CmsUserSSOModel
529
+ * TPkgSnippetRenderer_PregCallbackHelper
530
+ * TPkgSnippetRenderer_ResourceHelper
531
+ * TPkgSnippetRendererFilter
532
+ * AtomicLock
533
+ * ViewRendererPostRenderListener
534
+ * LogChangeDataModel
535
+ * MigrationDataModel
536
+ * MigrationQueryData
537
+ * MigrationRecorderConstants
538
+ * QueryConstants
539
+ * DatabaseMigrationConstants
540
+ * MigrationDataModelReducer
541
+ To get the explanation for a specific class, use the prompt format:
542
+ ```text
543
+ Explain the XYZ class. I don't want to see code, I want only the explanation.
544
+ ```
545
 
546
  ## Training Details
547
 
548
  ### Training Data
549
 
550
+ The model was trained on data from the following sources:
551
+ - [Chameleon Shop System](https://github.com/chameleon-system/chameleon-shop)
552
+ - [Chameleon System](https://github.com/chameleon-system/chameleon-system)
553
+ - [Chameleon Base](https://github.com/chameleon-system/chameleon-base)
554
 
555
  ### Training Procedure
556
 
557
+ - **Training Type:** Mixed precision (fp16) with 4-bit quantization
558
+ - **Prompt Format:** The model is trained to respond to prompts such as:
559
+ ```text
560
+ Explain the XYZ class. I don't want to see code, I want only the explanation.
561
+ Explain the ABC bundle. I don't want to see code, I want only the explanation.
562
+ ```
 
 
 
 
 
 
 
 
 
 
563
 
564
  ## Evaluation
565
 
566
+ The model was evaluated using specific Chameleon CMS classes to ensure accurate and useful explanations.
 
 
 
 
 
 
 
 
 
 
 
 
567
 
568
+ - **Metrics Used:**
569
+ - **Perplexity**: Evaluated for language modeling capabilities.
570
+ - **Accuracy**: Assessed based on how well the model explains Chameleon CMS components.
 
 
 
 
571
 
572
  ### Results
573
+ The model demonstrated good accuracy in explaining the components of Chameleon CMS, providing clear and detailed answers.
 
 
 
 
 
 
 
 
 
 
 
574
 
575
  ## Environmental Impact
576
 
577
+ - **Hardware Type:** Tesla T4 GPU
578
+ - **Training Hours:** 10 hours
579
+ - **Cloud Provider:** Google Cloud (US Central)
580
+ - **Estimated Carbon Emission:** 5 kg CO2eq
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
581
 
582
+ ## Technical Specifications
583
 
584
+ - **Model Architecture:** Transformer-based model with 4-bit quantization.
585
+ - **Compute Infrastructure:**
586
+ - Hardware: Tesla T4 GPU
587
+ - Software: PyTorch 2.4.1, CUDA 12.1
588
 
589
+ ## Contact
590
 
591
+ For any questions or issues, you can reach out to:
592
+ - **Email:** [hello@d8devs.com](mailto:hello@d8devs.com)
593
 
594
+ ## License
595
 
596
+ The model is available under the Apache 2.0 License.
597
 
598
+ ## Citation
599
 
600
+ If you use this model, please cite it as follows:
 
601
 
602
+ ```bibtex
603
+ @misc{kzorluoglu2024chameleon,
604
+ author = {kzorluoglu},
605
+ title = {Chameleon-Code_Explation_Gemma29b-v3},
606
+ year = {2024},
607
+ url = {https://github.com/kzorluoglu},
608
+ note = {Apache 2.0 License}
609
+ }
610
+ ```