Skip to content

Commit

Permalink
Merge branch '0.1.3' of github.com:SysCV/vis4d into 0.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
RoyYang0714 committed Aug 23, 2024
2 parents f90fdb4 + d042e2f commit 633a711
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

project = "Vis4D"
copyright = "2022, ETH Zurich"
author = "Tobias Fischer"
author = "Vis4D Team"


# -- General configuration ---------------------------------------------------
Expand Down
3 changes: 3 additions & 0 deletions docs/source/datasets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
********
Datasets
********
12 changes: 7 additions & 5 deletions docs/source/dev_guide/cli.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
###
CLI
###

We provide a command line interface for training and evaluating your models.
Assuming you have installed the package using pip, you can use the command `vis4d` to access the CLI.

Alternatively, you can run the CLI using `python -m vis4d.engine.cli` or `python -m vis4d.pl.cli` if you want to use the PyTorch Lightning version.
Alternatively, you can run the CLI using `python -m vis4d.engine.run` or `python -m vis4d.pl.run` if you want to use the PyTorch Lightning version.

The CLI relies on a configuration file to specify each experiment. We use `ml_collections <https://github.com/google/ml_collections>`_ as underlying framework to define the configuration files.
You can read up on our configuration files in the `Config System <configuration_files>`_ section.

=============
CLI Interface
=============

The provided examples assume that the experiment configuration file is located at `path_to_experiment_cfg.py`.
You can read up on our configuration files in the `Config System <configuration_files>`_ section.

Expand All @@ -20,6 +22,7 @@ We support both, our own training engine as well as `PyTorch Lightning <https://
------------
CLI Commands
------------

.. code-block:: bash
vis4d [fit | test] --config path_to_experiment_cfg.py
Expand Down Expand Up @@ -54,16 +57,14 @@ Quick Start

.. code-block:: bash
vis4d fit --config path_to_experiment_cfg.py
vis4d test --config path_to_experiment_cfg.py
**Overwrite Config Parameters**

.. code-block:: bash
vis4d fit --config path_to_experiment_cfg.py --config.my_field=2 --config.my.nested.field="test"
**Perform Parameter Sweeps**

.. code-block:: bash
Expand All @@ -87,6 +88,7 @@ Note that misstyping a config parameter
vis4d fit --config path_to_experiment_cfg.py --config.params.lrs=0.01
will result in the following error:

.. code-block:: bash
AttributeError: Did you mean "lr" instead of "lrw"?'
AttributeError: Did you mean "lr" instead of "lrs"?'
4 changes: 0 additions & 4 deletions docs/source/faq/trouble.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
Troubleshooting
***************

================
Training crashes
================

-----------
File limits
-----------
Expand Down

0 comments on commit 633a711

Please sign in to comment.