Skip to main content

The AI-ready robotics dev kit, with built-in remote control.

Project description

phosphobot

A community-driven platform for robotics enthusiasts to share and explore creative projects built with the phospho Junior Dev Kit.

phosphobot Python package on PyPi Y Combinator W24 phospho discord

Overview

This repository contains demo code and community projects developed using the phospho Junior Dev Kit. Whether you're a beginner or an experienced developer, you can explore existing projects or contribute your own creations.

Getting Started

  1. Get Your Dev Kit: Purchase your Phospho Junior Dev Kit at robots.phospho.ai. Unbox it and set it up following the instructions in the box.

  2. Control your Robot: Donwload the Meta Quest app, connect it to your robot, start teleoperating it.

  3. Record a Dataset: Record a dataset using the app. Do the same gesture 30-50 times (depending on the task complexity) to create a dataset.

  4. Install the Package:

pip install --upgrade phosphobot
  1. Train a Model: Use Le Robot to train a policy on the dataset you just recorded.
git clone https://github.com/huggingface/lerobot.git
cd lerobot
pip install -e .

Add the configs/policy/act_so100_phosphobot.yamlfile from this repository to the lerobot/configs/policy directory in the lerobot repository.

Launch the training script with the following command from the lerobot repository (change the device to cuda if you have an NVIDIA GPU, mps if you use a MacBook Pro Sillicon, and cpu otherwise):

sudo python lerobot/scripts/train.py \
  --dataset.repo_id=<HF_USERNAME>/<DATASET_NAME> \
  --policy.type=<act or diffusion or tdmpc or vqbet> \
  --output_dir=outputs/train/phoshobot_test \
  --job_name=phosphobot_test \
  --device=cpu \
  --wandb.enable=true

For the full detailed instructions, refer to the guide available here.

Next steps

  • Test the model: Run the following code to test the model you just trained (TODO)
  • Join the Community: Connect with other developers and share your experience in our Discord community

Community Projects

Explore projects created by our community members in the code_examples directory. Each project includes its own documentation and setup instructions.

Support

License

MIT License


Made with 💚 by the Phospho community

Project details


Release history Release notifications | RSS feed

This version

0.0.8

Download files

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

Source Distribution

phosphobot-0.0.8.tar.gz (10.6 MB view details)

Uploaded Source

Built Distribution

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

phosphobot-0.0.8-py3-none-any.whl (10.6 MB view details)

Uploaded Python 3

File details

Details for the file phosphobot-0.0.8.tar.gz.

File metadata

  • Download URL: phosphobot-0.0.8.tar.gz
  • Upload date:
  • Size: 10.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.4

File hashes

Hashes for phosphobot-0.0.8.tar.gz
Algorithm Hash digest
SHA256 9ce8dd52d01cd14ad79833bdfdb4c58c2ad64c92d69df32f349c2aeb33df3f61
MD5 24ebb3863960a149f42fe1fbe1626120
BLAKE2b-256 e89ceaa358cf8bf8dd248ba053e464db8bdea27e0846291ea98fceedfaf0235b

See more details on using hashes here.

File details

Details for the file phosphobot-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: phosphobot-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 10.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.4

File hashes

Hashes for phosphobot-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0c61d7b303409bd53346cb53d654bbccfecf585566ef9062d478bd2665271d35
MD5 0224dab4cb49cc3605945bb98bd5c70f
BLAKE2b-256 54218c6a78c47c5b1bd99c747778dfcc9e48ea6c0ed5576f076ada974f9065d1

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