jpacifico
/

French-Alpaca-Phi-3-mini-4k-instruct-beta

@@ -1,199 +1,77 @@
 ---
 library_name: transformers
-tags: []
 ---
-# 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. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **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]

 ---
 library_name: transformers
+license: mit
+language:
+- fr
+- en
+datasets:
+- jpacifico/French-Alpaca-dataset-Instruct-110K
+tags:
+- Phi-3
+- french
+- Phi-3-mini
 ---
+## Model Card for Model ID
+French-Alpaca based on microsoft/Phi-3-mini-128k-instruct
+128k is the context length (in tokens)
+![image/jpeg](https://github.com/jpacifico/French-Alpaca/blob/main/Assets/French-Alpaca_500px.png?raw=true)
 ### Model Description
+fine-tuned from the original French-Alpaca-dataset entirely generated with OpenAI GPT-3.5-turbo.
+French-Alpaca is a general model and can itself be finetuned to be specialized for specific use cases.
+The fine-tuning method is inspired from https://crfm.stanford.edu/2023/03/13/alpaca.html
+Quantized GGUF version : coming soon
+### Usage
+```python
+def stream_response(instruction, max_new_tokens=500, temperature=0.0, do_sample=False):
+    messages = [
+        {"role": "system", "content": "Vous êtes un assistant numérique serviable. Veuillez fournir des informations sûres, éthiques et précises à l'utilisateur."},
+        {"role": "user", "content": instruction}
+    ]
+    conversation_history = ""
+    for msg in messages:
+        conversation_history += msg["role"] + ": " + msg["content"] + "\n"
+    inputs = tokenizer(conversation_history, return_tensors="pt", padding=True, truncation=True)
+    input_ids = inputs['input_ids'].to("cuda")
+    output_sequences = model.generate(
+        input_ids=input_ids,
+        max_length=input_ids.shape[1] + max_new_tokens,
+        temperature=temperature,
+        do_sample=do_sample,
+        pad_token_id=tokenizer.eos_token_id,
+        eos_token_id=None
+    )
+    generated_text = tokenizer.decode(output_sequences[0], skip_special_tokens=True)
+    last_user_message = "user: " + instruction
+    response_start_index = generated_text.rfind(last_user_message) + len(last_user_message)
+    response = generated_text[response_start_index:].strip()
+    print(response)
+# Exemple d'utilisation
+instruction = "propose moi des façons de combiner des bananes et des pitayas pour les consommer."
+stream_response(instruction)
+```
+### Limitations
+The French-Alpaca model is a quick demonstration that a base tiny model can be easily fine-tuned to specialize in a particular language.
+It does not have any moderation mechanisms.
+- **Developed by:** Jonathan Pacifico, 2024
+- **Model type:** LLM
+- **Language(s) (NLP):** French
+- **License:** MIT