Instructions to use moondream/moondream-next with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use moondream/moondream-next with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="moondream/moondream-next", trust_remote_code=True)# pip install -U transformers accelerate # Load model directly from transformers import AutoModelForCausalLM model = AutoModelForCausalLM.from_pretrained("moondream/moondream-next", trust_remote_code=True, device_map="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use moondream/moondream-next with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "moondream/moondream-next" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "moondream/moondream-next", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker
docker model run hf.co/moondream/moondream-next
- SGLang
How to use moondream/moondream-next with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "moondream/moondream-next" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "moondream/moondream-next", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "moondream/moondream-next" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "moondream/moondream-next", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }' - Docker Model Runner
How to use moondream/moondream-next with Docker Model Runner:
docker model run hf.co/moondream/moondream-next
Download hf_moondream.py from moondream/moondream-next: direct link, hf CLI and curl.
- Browser
- Download file 3.96 kB
-
https://huggingface.co/moondream/moondream-next/resolve/main/hf_moondream.py
- Command line
-
hf download hf://moondream/moondream-next/hf_moondream.py
-
curl -L -o hf_moondream.py https://huggingface.co/moondream/moondream-next/resolve/main/hf_moondream.py
3.96 kB
| from transformers import PreTrainedModel, PretrainedConfig | |
| from .config import MoondreamConfig | |
| from .moondream import MoondreamModel | |
| # Files sometimes don't get loaded without these... | |
| from .image_crops import * | |
| from .vision import * | |
| from .text import * | |
| from .region import * | |
| from .utils import * | |
| def extract_question(text): | |
| prefix = "<image>\n\nQuestion: " | |
| suffix = "\n\nAnswer:" | |
| if text.startswith(prefix) and text.endswith(suffix): | |
| return text[len(prefix) : -len(suffix)] | |
| else: | |
| return None | |
| class HfConfig(PretrainedConfig): | |
| _auto_class = "AutoConfig" | |
| model_type = "moondream1" | |
| def __init__(self, **kwargs): | |
| super().__init__(**kwargs) | |
| self.config = {} | |
| class HfMoondream(PreTrainedModel): | |
| _auto_class = "AutoModelForCausalLM" | |
| config_class = HfConfig | |
| def __init__(self, config): | |
| super().__init__(config) | |
| self.model = MoondreamModel( | |
| MoondreamConfig.from_dict(config.config), setup_caches=False | |
| ) | |
| self._is_kv_cache_setup = False | |
| def _setup_caches(self): | |
| if not self._is_kv_cache_setup: | |
| self.model._setup_caches() | |
| self._is_kv_cache_setup = True | |
| def encode_image(self): | |
| self._setup_caches() | |
| return self.model.encode_image | |
| def query(self): | |
| self._setup_caches() | |
| return self.model.query | |
| def caption(self): | |
| self._setup_caches() | |
| return self.model.caption | |
| def detect(self): | |
| self._setup_caches() | |
| return self.model.detect | |
| def point(self): | |
| self._setup_caches() | |
| return self.model.point | |
| def detect_gaze(self): | |
| self._setup_caches() | |
| return self.model.detect_gaze | |
| def answer_question( | |
| self, | |
| image_embeds, | |
| question, | |
| tokenizer=None, | |
| chat_history="", | |
| result_queue=None, | |
| max_new_tokens=256, | |
| **kwargs | |
| ): | |
| answer = self.query(image_embeds, question)["answer"].strip() | |
| if result_queue is not None: | |
| result_queue.put(answer) | |
| return answer | |
| def batch_answer(self, images, prompts, tokenizer=None, **kwargs): | |
| answers = [] | |
| for image, prompt in zip(images, prompts): | |
| answers.append(self.query(image, prompt)["answer"].strip()) | |
| return answers | |
| def _unsupported_exception(self): | |
| raise NotImplementedError( | |
| "This method is not supported in the latest version of moondream. " | |
| "Consider upgrading to the updated API spec, or alternately pin " | |
| "to 'revision=2024-08-26'." | |
| ) | |
| def generate(self, image_embeds, prompt, tokenizer, max_new_tokens=128, **kwargs): | |
| """ | |
| Function definition remains unchanged for backwards compatibility. | |
| Be aware that tokenizer, max_new_takens, and kwargs are ignored. | |
| """ | |
| prompt_extracted = extract_question(prompt) | |
| if prompt_extracted is not None: | |
| answer = self.model.query( | |
| image=image_embeds, question=prompt_extracted, stream=False | |
| )["answer"] | |
| else: | |
| image_embeds = self.encode_image(image_embeds) | |
| prompt_tokens = torch.tensor( | |
| [self.model.tokenizer.encode(prompt).ids], | |
| device=self.device, | |
| ) | |
| def generator(): | |
| for token in self.model._generate_text( | |
| prompt_tokens, | |
| image_embeds.kv_cache, | |
| image_embeds.pos, | |
| max_new_tokens, | |
| ): | |
| yield token | |
| answer = "".join(list(generator())) | |
| return [answer] | |
| def get_input_embeddings(self): | |
| return super().get_input_embeddings() | |
| def input_embeds(self, *args, **kwargs): | |
| self._unsupported_exception() | |