Improve model card: Add pipeline tag, library name, paper, code, and project page links

README.md

@@ -1,10 +1,29 @@
 ---
+datasets:
+- fnlp/AnyInstruct
+language:
+- en
 license: apache-2.0
+pipeline_tag: any-to-any
+library_name: transformers
+---
+
+---
 datasets:
 - fnlp/AnyInstruct
 language:
 - en
+license: apache-2.0
+pipeline_tag: any-to-any
+library_name: transformers
 ---
+
+[Paper: AnyGPT: Unified Multimodal LLM with Discrete Sequence Modeling](https://huggingface.co/papers/2402.12226)
+
+[Code: OpenMOSS/AnyGPT](https://github.com/OpenMOSS/AnyGPT)
+
+[Project Page](https://junzhan2000.github.io/AnyGPT.github.io/)
+
 # Chat model for paper "AnyGPT: Unified Multimodal LLM with Discrete Sequence Modeling"
 
 ## Introduction
@@ -102,6 +121,49 @@ Due to limitations in data and training resources, the model's generation may st
 
 The speech and music response will be saved to ```.wav``` files, and the image response will be saved to a ```jpg```. The filename will be a concatenation of the prompt and the time. The paths to these files will be indicated in the response.
 
+### Chat model CLI Inference
+
+```bash
+python anygpt/src/infer/cli_infer_chat_model.py \
+--model-name-or-path 'path/to/model' \
+--image-tokenizer-path 'path/to/model' \
+--speech-tokenizer-path 'path/to/model' \
+--speech-tokenizer-config 'path/to/config' \
+--soundstorm-path 'path/to/model' \
+--output-dir "infer_output/chat"
+```
+
+for example
+
+```bash
+python anygpt/src/infer/cli_infer_chat_model.py \
+--model-name-or-path models/anygpt/chat \
+--image-tokenizer-path models/seed-tokenizer-2/seed_quantizer.pt \
+--speech-tokenizer-path models/speechtokenizer/ckpt.dev \
+--speech-tokenizer-config models/speechtokenizer/config.json \
+--soundstorm-path models/soundstorm/speechtokenizer_soundstorm_mls.pt \
+--output-dir "infer_output/chat"
+```
+
+Instruct format
+
+```bash
+interleaved|{text_instruction}|{modality}|{image_path}|{voice_prompt}|{speech_instruction}|{music_path}
+```
+
+Where ``text_instruction`` is the input text command, ``speech_instruction`` is the input voice command; only one needs to be specified.
+
+``image_path`` and ``music_path`` are the paths for the input image and music, respectively. ``voice_prompt`` is the specified tone of the model's response; if not specified, a random tone is used.
+
+``modality`` refers to the type of output modality, which can be chosen as speech, image, or music; otherwise, it is considered as text. This will only affect which decoding configuration file under the config directory is used by the model (this is because the model's training is limited, leading to different decoding strategies for different modalities). It can also decode token by token, modifying the decoding strategy to the corresponding modality when generating the start token of the modality.
+
+**example**
+
+* interleaved||image|||static/infer/speech/instruction/Can you draw me a picture of a sunny beach.wav
+* interleaved||music|||static/infer/speech/instruction/Give me a similar style of music.wav
+
+To clear the conversation history, please input ``|clear``
+
 ### Training
 #### Pretraining