README.md

---
license: apache-2.0
language:
- en
base_model:
- unsloth/gemma-2-9b-bnb-4bit
pipeline_tag: question-answering
tags:
- chameleon
- shop
- esono
---
# Chameleon-Code_Explation_Gemma29b-v3 - Draft

** Running Project - Draft*
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.

## Table of Contents
- [Model Overview](#model-overview)
- [Getting Started](#getting-started)
- [Available Bundles](#available-bundles)
- [Available Classes](#available-classes)
- [Training Details](#training-details)
- [Evaluation](#evaluation)
- [Environmental Impact](#environmental-impact)
- [Technical Specifications](#technical-specifications)
- [Contact](#contact)

## Model Overview

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.

- **Base Model:** Google Gemma 2 9B
- **Library Used:** PEFT
- **Language:** English
- **License:** Apache 2.0
- **Developer:** kzorluoglu
- **Model Source:** [Unsloth GitHub](https://github.com/unslothai/unsloth)

## Getting Started

To use the model, you can start by installing the necessary dependencies and downloading the model using the Hugging Face Transformers library.

### Installation

Install the `transformers` library:

```sh
pip install transformers
```

### Usage

Here is an example code snippet to get started:

```python
from transformers import AutoModel, AutoTokenizer

model = AutoModel.from_pretrained("kzorluoglu/Chameleon-Code_Explation_Gemma29b-v2")
tokenizer = AutoTokenizer.from_pretrained("kzorluoglu/Chameleon-Code_Explation_Gemma29b-v2")

print("Chatbot is ready!")
print("Type 'exit' to end the chat.")
print("Ask like this for a good answer:")
print("Explain the XYZ class. I don't want to see code, I want only the explanation.")
print("Explain the ABC bundle. I don't want to see code, I want only the explanation.")

while True:
    question = input("You: ")
    if question.lower() == 'exit':
        print("Ending the chat. Goodbye!")
        break

    instruction = f"{question}"
    inputs = tokenizer([instruction], return_tensors="pt").to("cuda")
    outputs = model.generate(**inputs, max_new_tokens=256, use_cache=True)
    generated_text = tokenizer.batch_decode(outputs, skip_special_tokens=True)
    print(f"AI: {generated_text[0]}")
```

## Available Bundles

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:
* AmazonPaymentBundle
* ShopOrderStatusBundle
* ShopWishlistBundle
* ImageHotspotBundle
* ShopArticlePreorderBundle
* ShopCurrencyBundle
* ShopPaymentIPNBundle
* ShopAffiliateBundle
* ShopBundle
* ShopRatingServiceBundle
* SearchBundle
* ShopArticleReviewBundle
* ShopListFilterBundle
* ShopPaymentTransactionBundle
* ShopArticleDetailPagingBundle
* CmsEventBundle
* MediaManagerBundle
* ViewRendererBundle
* CmsCounterBundle
* UpdateCounterMigrationBundle
* CmsStringUtilitiesBundle
* ExternalTrackerBundle
* CookieConsentBundle
* CmsResultCacheBundle
* CmsActionPluginBundle
* CmsClassManagerBundle
* PkgCoreBundle
* ExtranetBundle
* CoreBundle
* CmsNavigationBundle
* JavaScriptMinificationBundle
* TrackViewsBundle
* CmsTextFieldBundle
* CmsCacheBundle
* AutoclassesBundle
* CmsChangeLogBundle
* DatabaseMigrationBundle
* Csv2SqlBundle
* NewsletterBundle
* DistributionBundle
* CmsFileManagerBundle
* SecurityBundle
* SnippetRendererBundle
* AtomicLockBundle
* TwigDebugBundle

To get the explanation for a specific class, use the prompt format:
```text
Explain the XYZ bundle. I don't want to see code, I want only the explanation.
```


## Available Classes

The model has been trained to provide explanations for a wide range of classes in the Chameleon CMS system, including but not limited to:

* MTFeedbackErrors
* AmazonDataConverter
* AmazonPaymentConfigFactory
* AmazonReferenceIdManager
* WebServerExample
* OffAmazonPaymentsNotifications_Samples_NotificationSample
* OffAmazonPaymentsNotifications_Samples_IpnLogFile
* SnsMessageValidator
* IpnNotificationParser
* XmlNotificationParser
* Message
* SnsMessageParser
* OffAmazonPayments_Model
* OffAmazonPaymentsService_Model
* OffAmazonPaymentsService_Regions
* OffAmazonPaymentsService_RegionSpecificProperties
* OffAmazonPaymentsService_Environments
* OffAmazonPaymentsService_MerchantValues
* OffAmazonPaymentsService_Model_ResponseHeaderMetadata
* CancellationExample
* CLIExample
* SimpleCheckoutExample
* AddressConsentSample
* SplitShipmentsCheckoutExample
* RefundExample
* AutomaticPaymentsSimpleCheckoutExample
* ShippingAndTaxCostHelper
* CountryRates
* AmazonPaymentFixturesFactory
* ConfigValidator
* AmazonPaymentIdMapping
* TPkgShopOrderStatusManagerEndPoint
* PkgShopWishlistMailHistory
* PkgShopWishlistArticle
* PkgShopWishlistOrderItem
* PkgShopWishlist
* PkgImageHotspotItemMarker
* PkgImageHotspot
* PkgImageHotspotItemSpot
* PkgImageHotspotItem
* UpdateProductStockListener
* ShopCurrencyEvents
* TPkgShopPaymentIPNManager
* TPkgShopPaymentIPNRequest
* TPkgShopPaymentIPN_TransactionDetails
* PkgShopPaymentIpnMessage
* PkgShopPaymentIpnTrigger
* PkgShopPaymentIpnStatus
* PkgShopPaymentIpnMessageTrigger
* PkgShopAffiliate
* PkgShopAffiliateParameter
* ShopEvents
* TShopCategoryTree
* MTShopArticleListResponse
* TShopBreadcrumbItem
* TShopBasketArticleCustomDataValidationError
* TdbShopArticle
* ShopPaymentHandlerMock
* BasketVariableReplacer
* UpdateProductStatisticsListener
* UpdateVariantParentStockListener
* UpdateProductStockListener
* OrderPaymentInfo
* ShopPaymentConfigRawValue
* ShopSystemPage
* PkgShopArticlePreorder
* Shop
* ShopShippingGroupHandler
* ShopShippingGroup
* ShopWrappingCard
* ShopCategoryTab
* PkgShopListfilterItem
* PkgShopStatisticGroup
* ShopVat
* PkgShopFooterCategory
* PkgShopListfilterModuleConfig
* ShopSuggestArticleLog
* ShopBankAccount
* ShopCategory
* ShopDiscount
* PkgShopPrimaryNavi
* ShopShippingType
* ShopWrapping
* PkgShopListfilterItemType
* PkgShopCurrency
* PkgShopListfilter
* ShopUserNoticeList
* ShopSystemInfoModuleConfig
* PkgShopArticleReviewModuleShopArticleReviewConfiguration
* ShopSystemInfo
* ShopPaymentHandlerGroup
* ShopPaymentMethod
* ShopPaymentHandlerGroupConfig
* ShopPaymentHandler
* ShopPaymentHandlerParameter
* ShopArticleCatalogConfDefaultOrder
* ShopStockMessageTrigger
* ShopVariantType
* ShopArticleImageSize
* ShopAttribute
* ShopBundleArticle
* ShopArticleDocumentType
* ShopArticleMarker
* ShopArticle
* ShopArticleImage
* ShopArticleReview
* ShopArticleCatalogConf
* ShopArticleContributor
* ShopArticleDocument
* ShopVariantSet
* ShopStockMessage
* ShopArticleType
* ShopVariantDisplayHandler
* ShopUnitOfMeasurement
* ShopArticleStats
* ShopAttributeValue
* ShopVariantTypeHandler
* ShopContributorType
* ShopContributor
* ShopVariantTypeValue
* ShopManufacturerModuleConf
* ShopArticleStock
* ShopArticlePreviewImage
* ShopManufacturer
* ShopArticleGroup
* ShopVoucherUse
* ShopVoucherSeriesSponsor
* ShopUserPurchasedVoucher
* ShopVoucherSeries
* ShopVoucher
* ShopModuleArticleListArticle
* ShopModuleArticlelistOrderby
* ShopModuleArticleList
* ShopModuleArticleListFilter
* ShopOrderBasket
* ShopOrder
* ShopOrderStatusCode
* ShopOrderExportLog
* ShopOrderStatusItem
* ShopOrderStatus
* ShopOrderVat
* ShopOrderShippingGroupParameter
* ShopOrderItem
* ShopOrderStep
* ShopOrderBundleArticle
* ShopOrderPaymentMethodParameter
* ShopOrderDiscount
* SearchSuggestController
* XmlStreamer
* TShopAuskunftAPI
* PkgShopRatingServiceRating
* PkgShopRatingServiceTeaserCnf
* PkgShopRatingServiceWidgetConfig
* PkgShopRatingServiceHistory
* PkgShopRatingService
* TShopModuleArticleListFilterAutoParent
* TdbShopModuleArticleListFilter
* SearchResultTriggerCmsObserverListener
* SearchResultLoggerListener
* ShopSearchFieldWeight
* ShopSearchCloudWord
* ShopSearchCache
* ShopSearchQuery
* ShopSearchCacheItem
* ShopSearchIndexer
* ShopSearchKeywordArticle
* ShopSearchLog
* ShopSearchIgnoreWord
* AuthorDisplayConstants
* Slider
* Select
* DbAdapter
* TPkgShopPaymentTransactionItemDataEndPoint
* TPkgShopPaymentTransactionManagerEndPoint
* TPkgShopPaymentTransactionContextEndPoint
* PkgShopPaymentTransactionPosition
* PkgShopPaymentTransactionType
* PkgShopPaymentTransaction
* AddParametersToUrlService
* CacheUtil
* TPkgCmsEventManager
* DeleteMediaConnectionsListener
* ViewRenderer
* TPkgViewRendererMapper_ListHandlerData
* TPkgViewRendererLessCompiler
* TPkgViewRendererSnippetResourceCollectorEndPoint
* TPkgViewRendererSnippetDummyData
* TPkgViewRendererSnippetGalleryItem
* MapperVirtualSourceObject
* User
* Article
* GenerateCssController
* CmsCounter
* UpdateCounterMigrator
* UpdateCounterVersionMigrator
* MigrationConfigGenerator
* MigrateCountersListener
* TPkgCmsStringUtilities_HTML
* TPkgCmsStringUtilities_ReadConfig
* TPkgCmsStringUtilities_CleanPHPCode
* TPkgCmsStringUtilities_iOSMailURLEncoder
* TPkgCmsStringUtilities_PathUtils
* SearchResultTriggerCmsObserverListener
* CategoryTriggerCmsObserverListener
* AddCookieConsentIncludesListener
* TPkgCmsResultCacheManager
* TPkgCmsActionPluginManager
* AbstractPkgActionPlugin
* TPkgCmsVirtualClassManager
* TPkgCmsCoreSendToHost
* TPkgCoreUtility_Network
* TPkgCmsCoreLayoutPluginManager
* TPkgCmsCoreParameterContainerParameterDefinition
* AbstractPkgCmsCoreParameterContainer
* ExtranetEvents
* ExtranetUserConstants
* RefreshAuthenticityTokenListener
* RehashPasswordListener
* DelayFailedLoginAttemptListener
* LoginByTokenController
* ServiceLocator
* CoreEvents
* CronJobScheduleDataModel
* chameleon
* TableConfigurationDataModel
* CmsMasterPagdef
* DownloadLinkDataModel
* PagePath
* File
* Error
* UploaderController
* UploaderParametersDataModel
* UploadedFileDataModel
* StripVirtualFieldsFromQuery
* CronJobThatDoesNotExtendTCMSCronJob
* HtmlHelper
* TGlobalBase
* TModuleLoader
* TModelBase
* MTCustomListCoreConfig
* TTemplateTools
* TCMRenderMediaTreeSelectBox
* TCMSRegistry
* TCMSSmartURL
* TCMSTidyHTMLCleaner
* TCMSLockManager
* TCMSURLHistory
* TCMSRssHandler
* TCMSRender
* TPkgDependencyInjection
* TCMSLogChange
* TCMSViewPortManager
* TCMSRenderSeoPattern
* TCMSPageDefinitionFile
* TCMSRenderDocumentTreeSelectBox
* FalseValueCacheEntry
* TCMSMemcache
* TCMSTreeWidget
* TCMSTableToClass_MockRecord
* TCMSTableToClass
* TCacheManagerRuntimeCache
* TViewParser
* TCMSSmartURLData
* TCMSSmartURLHandler
* TCMSParameterMapperEndPoint
* TCMSMenuItem
* TCMSSpellcheck
* MTFeedbackErrorsCore
* TCMSErrorHandler
* MySqlLegacySupport
* TCMSFile
* TDbChangeLogManagerForModules
* TCMSTableEditorManager
* TCMSTableEditorEndPoint
* TCMSTableEditorMenuItem
* TCMSMessageManager
* TCMSImageEndpoint
* THTMLTable
* THTMLTableColumn
* HtmlParser
* TGoogleMapMarker
* TGoogleOverviewMap
* TGoogleMapEndPoint
* TGoogleMapIcon
* TCMSBreadcrumbNavi
* TCMSBreadcrumbNaviItem
* TGroupTableField
* TGroupTable
* TGroupTableStyle
* TPkgRunFrontendActionStatus
* TCMSGroupedStatistics
* TCMSGroupedStatisticsGroup
* TCCustomNavigation
* SQLParser
* SQLParenthesesParser
* imageMagick
* antiSpam
* TPkgCmsSessionWakeUpService
* TCMSListManagerEndPoint
* TCMSUserInput
* TCMSUserInputFilter_BaseClass
* TCMSUpdateManager
* TTools
* CheckPortalDomainListener
* CaseInsensitivePortalExceptionListener
* TemplateEngineAccessListener
* AddAntispamIncludesListener
* BackendBreadcrumbListener
* AddControllerIncludesListener
* CleanupBreadcrumbAfterDeleteListener
* RedirectToSecurePageListener
* ClearRoutingCacheListener
* InitializeRequestListener
* ReleaseOldLocksOnLoginListener
* AddGlobalHeadIncludesListener
* MigrateSessionListener
* AddModuleIncludesListener
* ChangeChameleonObjectsLocaleListener
* AddBackendToasterMessageListener
* NoCacheForSecurePageListener
* RehashBackendUserPasswordListener
* AllowEmbeddingForDifferentDomainListener
* AddJqueryIncludeListener
* BackendTreeNodeFactory
* RequestInitializer
* FieldTranslationUtil
* UrlUtil
* MltFieldUtil
* UrlNormalizationUtil
* AbstractDatabaseAccessLayer
* TranslationConstants
* JsTranslationController
* ModuleIconMigrator
* MainMenuMigrator
* IconMapping
* MenuItem
* MenuCategory
* ChameleonControllerEvents
* ImageNotFoundController
* BackendAccessCheck
* CsrfTokenManagerFactory
* Migrator
* ComposerData
* ComposerJsonModifier
* AbstractPkgCmsNavigationNode
* JavaScriptMinifyEventListener
* ImageCropPresetDataModel
* ImageCropDataModel
* ImageDataModel
* CmsMediaDataModel
* TPkgTrackObjectViews
* TrackViewsListener
* TCMSTextFieldEndPoint
* TdbCmsLanguage
* RequestListener
* AutoClassLoader
* MappingDataModel
* DataModelParts
* name
* MediaItemChainUsageFinder
* SortColumnCollection
* MediaItemUsageChainDeleteService
* MediaManagerExtensionCollection
* MediaManagerListResult
* MediaManagerListRequest
* AccessRightsModel
* MediaManagerListState
* MediaTreeDataModel
* MediaItemUsageDataModel
* MediaTreeNodeDataModel
* MediaItemDataModel
* JavascriptPluginRenderedContent
* JavascriptPluginMessage
* JavascriptPluginConfigurationState
* JavascriptPluginConfigurationUrls
* JavascriptPluginConfiguration
* MediaTreeNodeJsonObject
* TCMSChangeLogArchiver
* TCMSChangeLogFormatter
* SnippetChainModifier
* MigrationRecorderStateHandler
* MigrationRecorder
* QueryWriter
* DataModelConverter
* TPkgCsv2SqlManager
* NewsletterPostProcessorListener
* NewsletterUserDataModel
* PostUpdateVersionCheck
* ChameleonVersion
* MatchLevel
* InitialBackendUserCreator
* TPkgCmsFileManager_Utilities
* RedirectOnPendingUpdatesEventListener
* SecurityHelperAccess
* CmsUserRoleConstants
* CmsPermissionAttributeConstants
* CmsUserSSOModel
* TPkgSnippetRenderer_PregCallbackHelper
* TPkgSnippetRenderer_ResourceHelper
* TPkgSnippetRendererFilter
* AtomicLock
* ViewRendererPostRenderListener
* LogChangeDataModel
* MigrationDataModel
* MigrationQueryData
* MigrationRecorderConstants
* QueryConstants
* DatabaseMigrationConstants
* MigrationDataModelReducer
* 
To get the explanation for a specific class, use the prompt format:
```text
Explain the XYZ class. I don't want to see code, I want only the explanation.
```

## Training Details

### Training Data

The model was trained on data from the following sources:
- [Chameleon Shop System](https://github.com/chameleon-system/chameleon-shop)
- [Chameleon System](https://github.com/chameleon-system/chameleon-system)
- [Chameleon Base](https://github.com/chameleon-system/chameleon-base)

### Training Procedure

- **Training Type:** Mixed precision (fp16) with 4-bit quantization
- **Prompt Format:** The model is trained to respond to prompts such as:
  ```text
  Explain the XYZ class. I don't want to see code, I want only the explanation.
  Explain the ABC bundle. I don't want to see code, I want only the explanation.
  ```

## Evaluation

The model was evaluated using specific Chameleon CMS classes to ensure accurate and useful explanations.

- **Metrics Used:**
  - **Perplexity**: Evaluated for language modeling capabilities.
  - **Accuracy**: Assessed based on how well the model explains Chameleon CMS components.

### Results
The model demonstrated good accuracy in explaining the components of Chameleon CMS, providing clear and detailed answers.

## Environmental Impact

- **Hardware Type:** Tesla T4 GPU
- **Training Hours:** 10 hours
- **Cloud Provider:** Google Cloud (US Central)
- **Estimated Carbon Emission:** 5 kg CO2eq

## Technical Specifications

- **Model Architecture:** Transformer-based model with 4-bit quantization.
- **Compute Infrastructure:**
  - Hardware: Tesla T4 GPU
  - Software: PyTorch 2.4.1, CUDA 12.1

## Contact

For any questions or issues, you can reach out to:
- **Email:** [hello@d8devs.com](mailto:hello@d8devs.com)

## License

The model is available under the Apache 2.0 License.

## Citation

If you use this model, please cite it as follows:

```bibtex
@misc{kzorluoglu2024chameleon,
  author = {kzorluoglu},
  title = {Chameleon-Code_Explation_Gemma29b-v3},
  year = {2024},
  url = {https://github.com/kzorluoglu},
  note = {Apache 2.0 License}
}
```