From 59e722d14ea6d014272e447b011e819ef6433c1e Mon Sep 17 00:00:00 2001 From: Gustavo de Rosa Date: Tue, 16 Jan 2024 14:56:49 +0000 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 60f07a1..6f8d908 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,16 @@ For a safer model release, we exclude generic web-crawl data sources such as com Phi-1.5 can write poems, draft emails, create stories, summarize texts, write Python code (such as downloading a Hugging Face transformer model), etc. +## How to Use + +Phi-1.5 has been integrated in the development version (4.37.0.dev) of `transformers`. Until the official version is released through `pip`, ensure that you are doing one of the following: + +* When loading the model, ensure that `trust_remote_code=True` is passed as an argument of the `from_pretrained()` function. + +* Update your local `transformers` to the development version: `pip uninstall -y transformers && pip install git+https://github.com/huggingface/transformers`. The previous command is an alternative to cloning and installing from the source. + +The current `transformers` version can be verified with: `pip list | grep transformers`. + ## Intended Uses Given the nature of the training data, Phi-1.5 is best suited for prompts using the QA format, the chat format, and the code format. Note that Phi-1.5, being a base model, often produces irrelevant text following the main answer. In the following example, we've truncated the answer for illustrative purposes only.