predibase
/

customer_support_accounts

PEFT

Safetensors

Model card Files Files and versions Community

arnavgrg commited on Mar 26, 2024

Commit

07ff875

verified ·

1 Parent(s): 27b6aaf

Update README.md

Browse files

Files changed (1) hide show

README.md +52 -176

README.md CHANGED Viewed

@@ -1,204 +1,80 @@
 ---
 library_name: peft
 base_model: mistralai/Mistral-7B-v0.1
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]
 ### Framework versions
-- PEFT 0.8.2

 ---
 library_name: peft
 base_model: mistralai/Mistral-7B-v0.1
+license: apache-2.0
+datasets:
+- bitext/Bitext-customer-support-llm-chatbot-training-dataset
+language:
+- en
+tags:
+- text-generation-inference
 ---
+# Description
+This LoRA adapter was fine-tuned on the `bitext/Bitext-customer-support-llm-chatbot-training-dataset`, specifically by:
+1. Grouping the data on the following `category` column values: `ACCOUNT`, `CANCEL`, `SUBSCRIPTION`
+2. Merging `intent` and `response` columns into a new single column called `response_json` that is a JSON object consistint of two keys: `intent` and `response`.
+This is what the dataset looks like once it is preprared:
+![Accounts Dataset](https://github.com/arnavgarg1/shareable_artifacts_for_talks/blob/main/MLOps%20World%202024/accounts_dataset.png)
+# How To Use This Model
+## Prompt Template
+This adapter was instruction tuned using the following prompt template:
+```text
+You are a support agent for a company and you receive requests from customers.
+Your job is to reply to the customer by providing both the intent, which you
+should determine from the customer's request, as well as an appropriate response.
+Please note that the intent can only be one of the following: registration_problems, newsletter_subscription, recover_password, check_cancellation_fee, create_account, switch_account, edit_account, delete_account.
+Please package your reply in the JSON format.
+Request: {instruction}
+Reply:
+```
+At inference time, just replace/insert `{instruction}` with an actual instruction.
+## Example Input and Output
+Input:
+```
+You are a support agent for a company and you receive requests from customers.
+Your job is to reply to the customer by providing both the intent, which you
+should determine from the customer's request, as well as an appropriate response.
+Please note that the intent can only be one of the following: registration_problems, newsletter_subscription, recover_password, check_cancellation_fee, create_account, switch_account, edit_account, delete_account.
+Please package your reply in the JSON format.
+Request: where can I get information about opening {{Account Category}} accounts?
+Reply:
+```
+Output (rendered using pprint, but is a proper JSON with full key-value pairs):
+```python
+{'intent': 'create_account',
+ 'response': "I'm glad you asked! You can find all the information you need "
+             'about opening {{Account Category}} accounts on our website. '
+             'Simply visit our homepage and navigate to the account section. '
+             "There, you'll find detailed information about the benefits, "
+             'features, and requirements for opening a {{Account Category}} '
+             'account. If you have any specific questions or need further '
+             'assistance, feel free to reach out to our customer support team '
+             "who will be more than happy to help you. We're here to make the "
+             'process as smooth as possible for you!'}
+```
 ### Framework versions
+- PEFT 0.8.2
+- Ludwig 0.10.2