Skip to content

Commit

Permalink
Fixing Syntax and removing virtual env
Browse files Browse the repository at this point in the history
  • Loading branch information
shantanuparab-tr committed Sep 20, 2024
1 parent 62e7615 commit 932f386
Showing 1 changed file with 13 additions and 34 deletions.
47 changes: 13 additions & 34 deletions docs/operation/lerobot_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,30 @@
LeRobot X Aloha User Guide
==========================

Virtual Environment Setup
=========================

Containerization is crucial for running machine learning models to avoid dependency conflicts.
You can either use a Virtual Environment (venv) or Conda for this purpose.

Using Virtual Environment (venv)
--------------------------------

#. Install the virtual environment package:

.. code-block:: bash

$ sudo apt-get install python3-venv
Setting up Conda Environment
============================

#. Create a virtual environment:
Download and Install Miniconda
------------------------------

.. code-block:: bash
To begin, follow the official `Miniconda Installation Guide <https://docs.anaconda.com/miniconda/miniconda-install/>`_
to download and install Miniconda on your system.

$ python3 -m venv ~/lerobot # Creates a venv "lerobot" in the home directory
#. Activate the virtual environment:

.. code-block:: bash
$ source ~/lerobot/bin/activate
Using Conda
-----------
Environment Setup
-----------------

#. Create a virtual environment:

.. code-block:: bash
$ conda create -n lerobot python=3.10
conda create -n lerobot python=3.10
#. Activate the virtual environment:

.. code-block:: bash
$ conda activate lerobot
.. note::

Use either `venv` or `Conda` based on your preference, but **do not** mix them to avoid dependency issues.
conda activate lerobot
Clone Repository
================
Expand Down Expand Up @@ -158,7 +137,7 @@ The system supports episode-based data collection, where episodes are time-bound
#. The :guilabel:`--num-episodes` defines the total number of episodes to be collected.
Therefore it will check the existing output directories for any previously recorded episodes and will start recording from the last recorded episode.

#. The recorded data is pushed to hugging face hub by default you can set this false by using :guilabel:`--push_to_hub 0`.
#. The recorded data is pushed to hugging face hub by default you can set this false by using :guilabel:`--push-to-hub 0`.

.. note::

Expand Down Expand Up @@ -346,7 +325,7 @@ Troubleshooting
If you encounter issues, follow these troubleshooting steps:

OpenCV Installation Issues (Linux)
--------------------------------------
----------------------------------

If you encounter OpenCV installation issues, uninstall it via :guilabel:`pip` and reinstall using Conda:

Expand All @@ -356,7 +335,7 @@ OpenCV Installation Issues (Linux)
$ conda install -c conda-forge opencv=4.10.0
FFmpeg Encoding Error (:guilabel:`unknown encoder libsvtav1`)
---------------------------------------------------
-------------------------------------------------------------

Install FFmpeg with :guilabel:`libsvtav1` support via Conda-Forge or Homebrew:

Expand Down

0 comments on commit 932f386

Please sign in to comment.