Update README.md

README.md

@@ -1,3 +1,134 @@
----
-license: mit
----
+---
+license: mit
+pipeline_tag: text-generation
+tags:
+- ocean
+- text-generation-inference
+- oceangpt
+language:
+- en
+- zh
+base_model:
+- Qwen/Qwen3-4B-Thinking-2507
+---
+<div align="center">
+<img src="logo.jpg" width="300px">
+
+**OceanGPT(沧渊): A Large Language Model for Ocean Science Tasks**
+
+<p align="center">
+  <a href="https://github.com/zjunlp/OceanGPT">Project</a> •
+  <a href="https://arxiv.org/abs/2310.02031">Paper</a> •
+  <a href="https://huggingface.co/collections/zjunlp/oceangpt-664cc106358fdd9f09aa5157">Models</a> •
+  <a href="http://oceangpt.zjukg.cn/">Web</a> •
+  <a href="#quickstart">Quickstart</a> •
+  <a href="#citation">Citation</a>
+</p>
+
+</div>
+
+OceanGPT-basic is based on Qwen3 and has been trained on an English and Chinese dataset in the ocean domain (**recent update 20251223**) .
+
+Please note that the models and data in this repository are updated regularly to fix errors. The latest update date will be added to the README for your reference.
+
+- ❗**We will continue to update.**
+- ❗**Disclaimer: This project is purely an academic exploration rather than a product. Please be aware that due to the inherent limitations of large language models, there may be issues such as hallucinations.**
+
+## ⏩Quickstart
+
+### Download the model
+
+Download the model: [zjunlp/OceanGPT-basic-4B-Thinking](https://huggingface.co/zjunlp/OceanGPT-basic-4B-Thinking)
+
+```
+git lfs install
+git clone https://huggingface.co/zjunlp/OceanGPT-basic-4B-Thinking
+```
+
+or
+
+```
+huggingface-cli download --resume-download zjunlp/OceanGPT-basic-4B-Thinking --local-dir OceanGPT-basic-4B-Thinking --local-dir-use-symlinks False
+```
+
+### Inference
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_name = "Qwen/Qwen3-4B-Thinking-2507"
+
+# load the tokenizer and the model
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype="auto",
+    device_map="auto"
+)
+
+# prepare the model input
+system_prompt = "你是海洋知识专家，负责解答各类海洋相关问题(You are a marine knowledge expert, responsible for answering all marine-related questions)."
+question = "<Your Question>"
+messages = [
+    {"role": "system", "content": system_prompt},
+    {"role": "user", "content": question}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True,
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
+
+# conduct text completion
+generated_ids = model.generate(
+    **model_inputs,
+    max_new_tokens=4096
+)
+output_ids = generated_ids[0][len(model_inputs.input_ids[0]):].tolist() 
+
+# parsing thinking content
+try:
+    # rindex finding 151668 (</think>)
+    index = len(output_ids) - output_ids[::-1].index(151668)
+except ValueError:
+    index = 0
+
+thinking_content = tokenizer.decode(output_ids[:index], skip_special_tokens=True).strip("\n")
+content = tokenizer.decode(output_ids[index:], skip_special_tokens=True).strip("\n")
+
+print("thinking content:", thinking_content) # no opening <think> tag
+print("content:", content)
+
+```
+
+## 🌻Acknowledgement
+
+OceanGPT (沧渊) is trained based on the open-sourced large language models including [Qwen](https://huggingface.co/Qwen), [MiniCPM](https://huggingface.co/collections/openbmb/minicpm-2b-65d48bf958302b9fd25b698f), [LLaMA](https://huggingface.co/meta-llama).
+
+OceanGPT is trained based on the open-sourced data and tools including [Moos](https://github.com/moos-tutorials), [UATD](https://openi.pcl.ac.cn/OpenOrcinus_orca/URPC2021_sonar_images_dataset), [Forward-looking Sonar Detection Dataset](https://github.com/XingYZhu/Forward-looking-Sonar-Detection-Dataset), [NKSID](https://github.com/Jorwnpay/NK-Sonar-Image-Dataset), [SeabedObjects-KLSG](https://github.com/huoguanying/SeabedObjects-Ship-and-Airplane-dataset), [Marine Debris](https://github.com/mvaldenegro/marine-debris-fls-datasets/tree/master/md_fls_dataset/data/turntable-cropped).
+
+Thanks for their great contributions!
+
+## Limitations
+
+- The model may have hallucination issues.
+
+- We did not optimize the identity and the model may generate identity information similar to that of Qwen/MiniCPM/LLaMA/GPT series models.
+
+- The model's output is influenced by prompt tokens, which may result in inconsistent results across multiple attempts.
+
+- The model requires the inclusion of specific simulator code instructions for training in order to possess simulated embodied intelligence capabilities (the simulator is subject to copyright restrictions and cannot be made available for now), and its current capabilities are quite limited.
+
+### 🚩Citation
+
+Please cite the following paper if you use OceanGPT in your work.
+
+```bibtex
+@article{bi2023oceangpt,
+  title={OceanGPT: A Large Language Model for Ocean Science Tasks},
+  author={Bi, Zhen and Zhang, Ningyu and Xue, Yida and Ou, Yixin and Ji, Daxiong and Zheng, Guozhou and Chen, Huajun},
+  journal={arXiv preprint arXiv:2310.02031},
+  year={2023}
+}
+```