RobotLearn
RemI (Remote Inria)
remi

Repository

pip install git+ssh://git@gitlab.inria.fr/galepage/remi.git
git clone git@gitlab.inria.fr:galepage/remi.git
cd remi
pip install -e .
[me@local-pc:~]$ cd <PATH_TO_MY_PROJECT>
[me@local-pc:project]$ remi init
╭----------------╮                              ╭--------------------------------╮
| Local computer |                              | Remote storage (local scratch) |
╰----------------╯                              ╰--------------------------------╯
 my_code/   ╮                                   ╭  my_code/
 folder_a/  |                                   |  folder_a/
 folder_b/  |                                   |  folder_b/
 file_a     |---------- `remi push` ----------->|  file_a/
 file_b     |                                   |  file_b/
 file_c     |                                   |  file_c/
 file_d     ╯                                   ╰  file_d/
 output/     <------- `remi pull output/`-------   output/
 notebooks/                                        notebooks/
 ignored_folder/                                   other_ignored_folder/


ignored folders (listed in `.remi/exclude.txt`):
- output/
- notebooks/
- ignored_folder/
- other_ignored_folder/
[me@local-pc:project]$ remi <COMMAND>
# Name for your project
project_name: PROJECT_NAME


# Inria username
username: INRIA_USERNAME


# Name of your Inria workstation
pc_name: INRIA_DESKTOP_HOSTNAME


# Location of the project on the remote computer
project_remote_path: /scratch/INRIA_DESKTOP_HOSTNAME/INRIA_USERNAME/.remi_projects/PROJECT_NAME


# Bastion used to ssh into Inria resources
bastion:
  hostname: bastion.inrialpes.fr
  username: INRIA_USERNAME


# Desktop background jobs
background:
    # Which backend to use (`screen` or `tmux`)
    backend: screen

    # Whether to keep the session alive after the job has ended.
    # It lets you attach to the session to see the program output.
    # If 'false', the session will be closed when the job is over and stdout/stderr will be lost.
    # CAUTION: If true, you will have to manually re-attach and close the session.
    keep_session_alive: false


# Virtual environment
virtual_env:
  # Which virtual environment backend to use (`conda` or `virtualenv`)
  type: virtualenv

  # For `virtualenv` or `conda` virtual environments, you can specify a custom path.
  path: venv/

  # The name of your virtual environment (for `conda` environments)
  name: my_conda_env

  # For `conda` environments, path to a `yaml` configuration path
  conda_env_file: environment.yaml

  # For `conda` environments, you may specify a python version
  python_version: 3.9


# Singularity container options
singularity:
  # The name of the 'recipe' file (`.def`) to build the singularity container.
  def_file_name: container.def

  # The name of the singularity image.
  output_sif_name: container.sif

  # A dictionnary of binds for the singularity container.
  # If the value is empty (''), the mount point is the same as the path on the host.
  # By default, the project folder is bound within the singularity container: This configuration
  # then allows you to add extra locations.
  # Example:
  #     /path_on_host/my_data: /path_in_container/my_data
  bindings:


# Oarsub options (for more details on `oarsub`, please refer to
# https://oar.imag.fr/docs/latest/user/commands/oarsub.html).
oarsub:

  # Job name
  job_name: PROJECT_NAME

  # Number of cpus requested.
  num_cpus: 1

  # Number of cpu cores requested.
  # If the value is 0, all the cores for the requested cpus will be used.
  num_cpu_cores: 0

  # Number of GPUs requested.
  # If the value is 0, no GPU will be requested (CPU only).
  num_gpus: 1

  # The maximum allowed duration for your job.
  walltime: '72:00:00'

  # The name of the requested cluster (perception, mistis, thoth...)
  cluster_name: perception

  # Optionnaly specify the id of a specific node (gpu3, node2...)
  host_id:

  # If the options above are too restricive for your use-case, you may
  # directly provide a property list that will be provided to `oarsub` with the
  # `-p` flag.
  custom_property_query:

  # Whether to schedule the job in the besteffort queue.
  besteffort: true

  # Whether to set the job as idempotent (see oarsub documentation for more details).
  idempotent: false


# Remote servers
# Remote servers are applications that run on a remote computer and can be accessed from your local
# browser thanks to remi.
# Two such servers are supported right now:
# - Jupyter notebook
# - TensorBoard
remote_servers:
    # The command to run for opening the local browser (`<browser_cmd> <url>`)
    browser_cmd: firefox

    # Jupyter notebook
    jupyter:
        # The port (local and remote) for the server
        port: 8080

        # If true, automatically open the jupyter notebook in the local browser.
        open_browser: true

    # TensorBoard
    tensorboard:
        # The port (local and remote) for TensorBoard
        port: 9090

        # Directory from where to run tensorboard.
        logdir: 'output/'

        # If true, automatically open TensorBoard in the local browser.
        open_browser: true