Upload README.md

README.md

@@ -1,3 +1,144 @@
----
-license: llama3.1
----
+---
+license: llama3.1
+language:
+- zh
+pipeline_tag: text-generation
+tags:
+- facebook
+- meta
+- pytorch
+- llama
+- llama-3
+- ContaLLM
+- ContaAI
+base_model:
+- meta-llama/Llama-3.1-8B-Instruct
+library_name: transformers
+---
+
+<img src="https://conta-ai-image.oss-cn-shanghai.aliyuncs.com/contaai/logo2.png" alt="ContaLLM" width="800" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+
+# ContaLLM-Beauty-8B-Instruct
+
+ContaLLM-Food-Beverage-8B-Instruct is a large Chinese vertical marketing model for the food and beverage industry. You can customize and generate marketing texts according to users' specific marketing needs, product selection, product selection knowledge base, keywords, main recommended selling points, main recommended scenes, hashtags, article types, etc. Use the LLM's capabilities and training on existing high-quality marketing materials to help companies generate diversified, high-quality marketing content and improve marketing conversion rates.
+
+## Model description
+
+- **Model type:** A model trained on a mix of publicly available, synthetic and human-annotated datasets.
+- **Language(s) (NLP):** Primarily Chinese
+- **Industry:** Food And Beverage Industry Marketing
+- **License:** Llama 3.1 Community License Agreement
+- **Finetuned from model:** meta-llama/Llama-3.1-8B-Instruct
+
+### Model Stage
+
+| **Industry** | **Version** | **Llama 3.1 8B**                                                                                          
+|--------------|-------------|------------------------------------------------------------------------------------------------------------|
+| **Beauty**   | **bf16**    | [ContaAI/ContaLLM-Food-Beverage-8B-Instruct](https://huggingface.co/ContaAI/ContaLLM-Food-Beverage-8B-Instruct) |
+| **Beauty**   | **8bit**    | [ContaAI/ContaLLM-Food-Beverage-8B-Instruct-8bit](https://huggingface.co/ContaAI/ContaLLM-Food-Beverage-8B-Instruct-8bit) |
+| **Beauty**   | **4bit**    | [ContaAI/ContaLLM-Food-Beverage-8B-Instruct-4bit](https://huggingface.co/ContaAI/ContaLLM-Food-Beverage-8B-Instruct-4bit) |
+
+## Using the model
+
+### Loading with HuggingFace
+
+To load the model with HuggingFace, use the following snippet:
+```
+from transformers import AutoModelForCausalLM
+
+model = AutoModelForCausalLM.from_pretrained("ContaAI/ContaLLM-Food-Beverage-8B-Instruct-8bit")
+```
+
+
+### System Prompt
+
+The model is a Chinese beauty marketing model, so we use this system prompt by default:
+```
+system_prompt = '请根据用户提供的营销需求、选品及其他信息写一篇食品饮料行业的营销推文。'
+```
+
+### User Prompt
+Users can enter the required marketing needs according to their own needs, non-required including keywords, topics, label marketing nodes, people, related materials, content length, which content length has three specifications, respectively, shorter, medium, longer. The details are as follows:
+
+| Parameter name    | Required              | Meaning and optional range                                                                           | 
+|-------------------|-----------------------|------------------------------------------------------------------------------------------------------|
+| **营销需求**          | required              | Fill in your marketing requirements, cannot be blank                                                 |
+| **选品**          | required              | Fill in your product selection, cannot be blank                                                 |
+| **选品知识库**          | required              | Fill in your product selection knowledge base, cannot be blank                                                 |
+| **关键词**           | optional              | Fill in your marketing keywords, or remove this row from the prompt                                  | 
+| **标签**            | optional              | Fill in the hashtag, or remove this row from the prompt                                              | 
+| **主推卖点**          | optional              | Fill in the main recommended selling points, or remove this row from the prompt | 
+| **主推场景**            | optional              | Fill in the main recommended scenes, or remove this row from the prompt                                  | 
+| **文章类型**          | optional              | Fill in the article type, or remove this row from the prompt          | 
+
+Example:
+```
+user_prompt = """营销需求：夏日清凉，日料风味体验
+选品：清新柠檬寿司卷
+选品知识库：1、选用新鲜的三文鱼和牛油果，搭配清爽柠檬汁，口感层次丰富。2、低脂健康，适合健身人士。3、每份仅含200大卡，轻松享受美味。
+关键词：日料、寿司、健康饮食、夏日美食
+主推卖点：清新健康
+主推场景：夏日聚会
+标签：#日料# #寿司# #健康美食
+文章类型：美食推荐"""
+```
+
+### Use example (with template)
+```
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+model_name = "ContaAI/ContaLLM-Food-Beverage-8B-Instruct-8bit"
+model = AutoModelForCausalLM.from_pretrained(model_name, load_in_8bit=True, device_map="auto")
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+system_prompt = '请根据用户提供的营销需求、选品及其他信息写一篇食品饮料行业的营销推文。'
+
+user_prompt = """营销需求：夏日清凉，日料风味体验
+选品：清新柠檬寿司卷
+选品知识库：1、选用新鲜的三文鱼和牛油果，搭配清爽柠檬汁，口感层次丰富。2、低脂健康，适合健身人士。3、每份仅含200大卡，轻松享受美味。
+关键词：日料、寿司、健康饮食、夏日美食
+主推卖点：清新健康
+主推场景：夏日聚会
+标签：#日料# #寿司# #健康美食
+文章类型：美食推荐"""
+
+prompt_template = '''<|begin_of_text|><|start_header_id|>system<|end_header_id|>
+{}<|eot_id|><|start_header_id|>user<|end_header_id|>
+{}<|eot_id|><|start_header_id|>assistant<|end_header_id|>'''
+
+prompt = prompt_template.format(system_prompt, user_prompt)
+
+tokenized_message = tokenizer(
+  prompt,
+  max_length=2048,
+  return_tensors="pt",
+  add_special_tokens=False
+)
+
+response_token_ids= model.generate(
+  **tokenized_message,
+  max_new_tokens=1024,
+  do_sample=True,
+  top_p=1.0,
+  temperature=0.5,
+  min_length=None,
+  use_cache=True,
+  top_k=50,
+  repetition_penalty=1.2,
+  length_penalty=1,
+)
+
+generated_tokens = response_token_ids[0, tokenized_message['input_ids'].shape[-1]:]
+generated_text = tokenizer.decode(generated_tokens, skip_special_tokens=True)
+print(generated_text)
+```
+
+### Bias, Risks, and Limitations
+
+The ContaLLM models implemented safety techniques during data generation and training, but they are not deployed automatically with in-the-loop filtering of responses like ChatGPT during inference, so the model can produce problematic outputs (especially when prompted to do so). 
+It is also unknown what the size and composition of the corpus was used to train the base Llama 3.1 models, however it is likely to have included a mix of Web data and technical sources like books and code. 
+The use of the models is at your own risk. You may need to monitor the outputs of the model and take appropriate actions such as content filtering if necessary.
+
+## License and use
+
+All Llama 3.1 ContaAI models are released under Meta's [Llama 3.1 Community License Agreement](https://www.llama.com/llama3_1/license/).