Skip to content

Commit

Permalink
Update github branch name
Browse files Browse the repository at this point in the history
  • Loading branch information
hmorimitsu committed Jan 31, 2024
1 parent 6cf715f commit cf029e0
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/source/starting/inference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Predict optical flow with a pretrained model
infer.py
========

`[source code] <https://github.com/hmorimitsu/ptlflow/tree/master/infer.py>`__
`[source code] <https://github.com/hmorimitsu/ptlflow/tree/main/infer.py>`__

We provide a script for making it easier to perform inference on different inputs.
Read :ref:`initial-scripts` to know how to download it.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/starting/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Predicting optical flow on test datasets

Some datasets, such as MPI-Sintel and KITTI, provide a test split of the dataset, which is to be used
for submitting results for the official rankings. PTLFlow provides a script
`test.py <https://github.com/hmorimitsu/ptlflow/tree/master/test.py>`__ that can be used to generate
`test.py <https://github.com/hmorimitsu/ptlflow/tree/main/test.py>`__ that can be used to generate
predictions for the test split of some benchmarks. Read :ref:`initial-scripts` to know how to download it.

At the moment, ``test.py`` only supports MPI-Sintel, KITTI 2012, and KITTI 2015 datasets by default.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/starting/training.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ trained some model inside PTLFlow, please feel free to contribute your results b
How to train a model
====================

You can use the script `train.py <https://github.com/hmorimitsu/ptlflow/tree/master/train.py>`_
You can use the script `train.py <https://github.com/hmorimitsu/ptlflow/tree/main/train.py>`_
Read :ref:`initial-scripts` to know how to download it.

In order to train a model, you should also keep a copy of
`datasets.yml <https://github.com/hmorimitsu/ptlflow/tree/master/datasets.yml>`_
`datasets.yml <https://github.com/hmorimitsu/ptlflow/tree/main/datasets.yml>`_
in the same directory as ``train.py``. Then you should update the paths inside ``datasets.yml``
to point to the dataset root folders in your machine.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/starting/validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Run validation on a model
=========================

You can use the script `validate.py <https://github.com/hmorimitsu/ptlflow/tree/master/validate.py>`__
You can use the script `validate.py <https://github.com/hmorimitsu/ptlflow/tree/main/validate.py>`__
to validate one of the available models. Read :ref:`initial-scripts` to know how to download it.

Once you have the script, you can run a validation as follows:
Expand Down Expand Up @@ -39,7 +39,7 @@ would use the following two datasets for the validation:

You can check the :ref:`train-val-dataset` page for more details about the ``val_dataset`` string options.
If you want to know about the train/val splits of each dataset, check the validation text files at
`https://github.com/hmorimitsu/ptlflow/tree/master/ptlflow/data <https://github.com/hmorimitsu/ptlflow/tree/master/ptlflow/data>`__.
`https://github.com/hmorimitsu/ptlflow/tree/main/ptlflow/data <https://github.com/hmorimitsu/ptlflow/tree/main/ptlflow/data>`__.

Using a local checkpoint
========================
Expand Down

0 comments on commit cf029e0

Please sign in to comment.