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


🤖 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: for faster video decoding, installing ffmpeg via sudo apt-get install ffmpeg (for Linux) is recommended.

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.

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

This version

8.0.3

Download files

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

Source Distribution

neuracore-8.0.3.tar.gz (311.0 kB view details)

Uploaded Source

Built Distribution

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

neuracore-8.0.3-py3-none-any.whl (401.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neuracore-8.0.3.tar.gz
Algorithm Hash digest
SHA256 f60f053813eb52e675117f382dacc1c9165efa13f4f496bc542c8703e456bf90
MD5 e78fc59d3ed5938a7f36ab504d68cd5d
BLAKE2b-256 29b87c17093fa7e6da334807196c05666ff49128c3be2835773d824cdb9d977e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for neuracore-8.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d971a71f1c4aec9d770e5dea0a41fa6b72b5412ada9c7d1052ac7852d830a311
MD5 8a505757c4c89da414fb89aa364dd74d
BLAKE2b-256 de470ce79c7a4157efd2a7d371e57b0c579ba90edf414618d400dc5aece691e5

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