Skip to main content

Neuracore Client Library

Project description

Neuracore Logo

Downloads Python 3.10+ PyPI - Version License: MIT Last Commit

Join our community!

Discord

Getting started

Discord


🤖 What is Neuracore

Neuracore is a powerful robot learning library that enables data collection and visualization, model training, deployment, and real-time inference with support for custom data types. Get started with Neuracore today, sign up for a Neuracore account!

Data Visualization

🌟 Features

  • 🚀 Streaming data logging with custom data types
  • 📊 Dataset visualization and synchronization
  • ☁️ Train robot learning algorithms on cloud
  • 🤖 Policy inference and deployment

🛠️ Installation

To install the basic package for data logging and visualization:

pip install neuracore

Note: installing the ffmpeg binary is recommended for faster video encoding (during recording) and decoding (during playback/import). If not available, Neuracore falls back to PyAV for encoding.

Linux (Debian/Ubuntu):

sudo apt-get update && sudo apt-get install -y ffmpeg

For training and ML development:

pip install neuracore[ml]

For bulk importing datasets:

pip install neuracore[import]

To run our examples:

pip install neuracore[examples]

🍰 A Short Taste

Here is a short taste on what neuracore can do. For a detailed walk-through, please refer to the tutorial and documentation, or try it yourself on Google Colab.

import neuracore as nc # pip install neuracore
import time

# ensure you have an account at neuracore.com
nc.login()

# Connect to a robot with URDF
nc.connect_robot(
    robot_name="MyRobot", 
    urdf_path="/path/to/robot.urdf",
)

# Create a dataset for recording
nc.create_dataset(
    name="My Robot Dataset",
    description="Example dataset with multiple data types"
)

# Recording and streaming data
nc.start_recording()
t = time.time()
nc.log_joint_positions(positions={'joint1': 0.5, 'joint2': -0.3}, timestamp=t)
nc.log_rgb(name="top_camera", rgb=image_array, timestamp=t)
# Stop recording, the dataset is automatically uploaded to the cloud
nc.stop_recording()

# Kick off cloud training
job_data = nc.start_training_run(
    name="MyTrainingJob",
    dataset_name="My Robot Dataset",
    algorithm_name="diffusion_policy",
    num_gpus=5,
    frequency=50,
    ...
)

# Load a trained model locally
policy = nc.policy(
    train_run_name="MyTrainingJob",
    ...
)

# Get model inputs
nc.log_joint_positions(positions={'joint1': 0.5, 'joint2': -0.3})
nc.log_rgb(name="top_camera", rgb=image_array)
# Model Inference
predictions = policy.predict(timeout=5)

📚 Documentation

💬 Community

We are building Neuracore to help everyone accelerate their robot learning workflows, and we'd love to hear from you! Join our community to get help, share ideas, and stay updated:

  • Discord - Chat with the community and get support
  • GitHub Issues - Report bugs and request features

🧾 Citation

If you use Neuracore in your research, please consider citing:

@software{Neuracore,
  author = {Neuracore Team},
  title = {Neuracore},
  month = {January},
  year = {2026},
  url = {https://github.com/NeuracoreAI/neuracore}
}

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

neuracore-10.0.0.tar.gz (336.7 kB view details)

Uploaded Source

Built Distribution

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

neuracore-10.0.0-py3-none-any.whl (426.0 kB view details)

Uploaded Python 3

File details

Details for the file neuracore-10.0.0.tar.gz.

File metadata

  • Download URL: neuracore-10.0.0.tar.gz
  • Upload date:
  • Size: 336.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for neuracore-10.0.0.tar.gz
Algorithm Hash digest
SHA256 a59dfef55ed0bc541209b959b6703ce74fcab0604e05ce4ea087ef18d0993b73
MD5 b9536e9237bfed65b6fef916e66f776f
BLAKE2b-256 7b94aa4dafbe0030307763e495b9e25afa4463fd40d93e8ac3ce024dca5cfe7d

See more details on using hashes here.

File details

Details for the file neuracore-10.0.0-py3-none-any.whl.

File metadata

  • Download URL: neuracore-10.0.0-py3-none-any.whl
  • Upload date:
  • Size: 426.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for neuracore-10.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 050e37bdbfafe8d7ca4b5f5d4e43461a6915f3b43ee1a64a0f59505f695c7623
MD5 3414a20e598ba4af0e29f8e87a690e1a
BLAKE2b-256 b1504fa71df5083b14872a539143a280dd99257f2dec48675ba48bafcba269b6

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