Skip to main content

Local inference and model management.

Project description

Moondream Station Logo

Moondream Station: Local Visual Reasoning

Home Page Discord Follow @moondreamai License


Video showing Moondream Station running in a terminal

How It Works

🚀 Launches Local Server
All inference runs on your device

🔧 Control via CLI
Caption images, answer questions, and manage settings

🌐 Access via HTTP
Connect to http://localhost:2020/v1 through REST or our Python, Node, or OpenAI client

Installation

Install from PyPI:

$ pip install moondream-station

Install from source:

$ git clone https://github.com/m87-labs/moondream-station.git
$ cd moondream-station
$ pip install -e .

That's it! Moondream Station will automatically set itself up.

Usage

Launch Moondream Station

To fire up Moondream Station, execute this command in your terminal:

$ moondream-station

Model Management

By default, Moondream Station uses the latest model your machine supports. If you want to view or activate other Moondream models, use the following commands:

  • models - List available models
  • models switch <model> - Switch to a model

Service Control

We like to think Moondream has 20/20 vision; that’s why, by default, we launch Moondream Station on port 2020. If that port is taken, Moondream Station will try a nearby free port. Additionally, you can control the port and status of the inference service with the following commands:

  • start [port] - Start REST server (default: port 2020)
  • stop - Stop server
  • restart - Restart server

Inference

Access via HTTP: Point any of our inference clients at your Moondream Station; for example, with our python client you can do:

import moondream as md
from PIL import Image

# connect to Moondream Station
model = md.vl(endpoint="http://localhost:2020/v1")

# Load an image
image = Image.open("path/to/image.jpg")

# Ask a question
answer = model.query(image, "What's in this image?")["answer"]
print("Answer:", answer)

For more information on our clients visit: Python, Node, Quick Start

Connect via CLI: Use all the capabilities of Moondream directly through your terminal. No need to touch any code!

  • infer <function> [args] - Run single inference
  • inference - Enter interactive inference mode

Settings

Control the number of workers, queue size, privacy settings, and more through Settings:

  • settings - Show configuration
  • settings set <key> <value> - Set setting value

Moondream Station collects anonymous usage metrics to help us improve the app. The following data is collected:

  • Event data: when you use features like caption, query, detect, or point.
  • Version information: active bootstrap, hypervisor, inference client, and model version.
  • System information: OS version, IP address, and Python version/runtime.

No personal information, images, or prompts/responses are ever collected. To opt out of logging, run: settings set logging false.

Utility

The utility functions provide insight into what Moondream Station is currently doing. To view statistics for your current session, use the session mode. To view a log of requests processed by Moondream Station, use the history command.

  • session - Show session stats
  • help - Show available commands
  • history - Show command history
  • reset - Reset app data & settings
  • clear - Clear screen
  • exit - Quit application

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moondream_station-0.1.9.tar.gz (41.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

moondream_station-0.1.9-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file moondream_station-0.1.9.tar.gz.

File metadata

  • Download URL: moondream_station-0.1.9.tar.gz
  • Upload date:
  • Size: 41.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for moondream_station-0.1.9.tar.gz
Algorithm Hash digest
SHA256 0f8f395d15e666a0f75a3cc70898ef9e5688e4affe4c9241a3e45b1150ddc42b
MD5 7add184a5d4f7907b75b44d73e43b197
BLAKE2b-256 28972380e4e6d717619410907ced1c3fbd8d22caca19ce9a6ceec881b3cc7d82

See more details on using hashes here.

File details

Details for the file moondream_station-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for moondream_station-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ef7ad29d8cb9336d934c5513ef5c5324cc8e09a33da38acd15d78ec59f589084
MD5 7424d7a05d9877674c37180f118f1db2
BLAKE2b-256 2898fdf6407ebed6fff2d50809015bc5fad80d16fa3b989498edd73e534cb3a9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page