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]

Note: The main branch is considered a development branch. For production use, we recommend installing from PyPI (as shown above) or using the latest tagged commit.

🍰 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 training
dataset = nc.get_dataset("My Robot Dataset")
job_data = nc.start_training_run(
    name="MyTrainingJob",
    num_gpus=5,
    frequency=50,
    algorithm_name=diffusion_policy,
    ...
)

# 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-7.14.1.tar.gz (217.5 kB view details)

Uploaded Source

Built Distribution

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

neuracore-7.14.1-py3-none-any.whl (277.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neuracore-7.14.1.tar.gz
Algorithm Hash digest
SHA256 3c3f4fc89570e78374dcdb449f1e533e00771733be1d904c94d3def664c362af
MD5 1a53aec361897e461c54335687b28a97
BLAKE2b-256 f6729ee0d4a0d86370676ef8ca1801208da656da0d246fd804f030a5b9d2d453

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuracore-7.14.1-py3-none-any.whl
  • Upload date:
  • Size: 277.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-7.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d4181fa444c917500a506a5d1cf892757c8ab88590aa755c22ec316d36e94974
MD5 cc20eb5422e56560507fe7913b0d69c5
BLAKE2b-256 df05200e4ccfd9f4b8794657e12d2bca438bcb660caad3172a7c8f8ec3ecd6e3

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