diff --git a/README.md b/README.md
index 0222ca2..c3b31b6 100644
--- a/README.md
+++ b/README.md
@@ -18,11 +18,11 @@ This repository holds implementations of the [LDR-FLIP](https://research.nvidia.
and [HDR-FLIP](https://research.nvidia.com/publication/2021-05_HDR-FLIP) image error metrics.
It also holds code for the FLIP tool, presented in [Ray Tracing Gems II](https://www.realtimerendering.com/raytracinggems/rtg2/index.html).
-The changes made for the different versions of FLIP are summarized in the [version list](misc/versionList.md).
+The changes made for the different versions of FLIP are summarized in the [version list](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/versionList.md).
-[A list of papers](flip_evaluator/misc/papersUsingFLIP.md) that use/cite FLIP.
+[A list of papers](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/papersUsingFLIP.md) that use/cite FLIP.
-[A note](flip_evaluator/misc/precision.md) about the precision of FLIP.
+[A note](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/precision.md) about the precision of FLIP.
[An image gallery](https://research.nvidia.com/node/3525) displaying a large quantity of reference/test images and corresponding error maps from
different metrics.
@@ -37,10 +37,10 @@ Copyright © 2020-2024, NVIDIA Corporation & Affiliates. All rights reserved.
This work is made available under a [BSD 3-Clause License](LICENSE).
-The repository distributes code for `tinyexr`, which is subject to a [BSD 3-Clause License](flip_evaluator/misc/LICENSE-third-party.md#bsd-3-clause-license),
-and `stb_image`, which is subject to an [MIT License](flip_evaluator/misc/LICENSE-third-party.md#mit-license).
+The repository distributes code for `tinyexr`, which is subject to a [BSD 3-Clause License](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LICENSE-third-party.md#bsd-3-clause-license),
+and `stb_image`, which is subject to an [MIT License](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LICENSE-third-party.md#mit-license).
-For individual contributions to the project, please confer the [Individual Contributor License Agreement](flip_evaluator/misc/CLA.md).
+For individual contributions to the project, please confer the [Individual Contributor License Agreement](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/CLA.md).
For business inquiries, please visit our website and submit the form: [NVIDIA Research Licensing](https://www.nvidia.com/en-us/research/inquiries/).
@@ -70,7 +70,7 @@ Tool:
flip --reference reference.{exr|png} --test test.{exr|png} [--options]
```
-See the [README](flip_evaluator/python/README.md) in the `python` folder and run `flip -h` for further information and usage instructions.
+See the [README](https://github.com/NVlabs/flip/blob/main/flip_evaluator/python/README.md) in the `python` folder and run `flip -h` for further information and usage instructions.
# C++ and CUDA (API and Tool)
**Setup:**
@@ -95,14 +95,14 @@ CUDA support is enabled via the `FLIP_ENABLE_CUDA`, which can be passed to CMake
**Usage:**
API:
-See the [README](flip_evaluator/cpp/README.md).
+See the [README](https://github.com/NVlabs/flip/blob/main/flip_evaluator/cpp/README.md).
Tool:
```
flip[-cuda].exe --reference reference.{exr|png} --test test.{exr|png} [options]
```
-See the [README](flip_evaluator/cpp/README.md) in the `flip_evaluator/cpp` folder and run `flip[-cuda].exe -h` for further information and usage instructions.
+See the [README](https://github.com/NVlabs/flip/blob/main/flip_evaluator/cpp/README.md) in the `flip_evaluator/cpp` folder and run `flip[-cuda].exe -h` for further information and usage instructions.
# PyTorch (Loss Function)
**Setup** (with Anaconda3 or Miniconda):
@@ -119,19 +119,19 @@ conda install -c conda-forge openexr-python
LDR- and HDR-FLIP are implemented as loss modules in `flip_evaluator/pytorch/flip_loss.py`. An example where the loss function is used to train a simple autoencoder is provided in `flip_evaluator/pytorch/train.py`.
-See the [README](flip_evaluator/pytorch/README.md) in the `pytorch` folder for further information and usage instructions.
+See the [README](https://github.com/NVlabs/flip/blob/main/flip_evaluator/pytorch/README.md) in the `pytorch` folder for further information and usage instructions.
# Citation
If your work uses the FLIP tool to find the errors between *low dynamic range* images,
please cite the LDR-FLIP paper:
-[Paper](https://research.nvidia.com/publication/2020-07_FLIP) | [BibTeX](flip_evaluator/misc/LDRFLIP.txt)
+[Paper](https://research.nvidia.com/publication/2020-07_FLIP) | [BibTeX](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LDRFLIP.txt)
If it uses the FLIP tool to find the errors between *high dynamic range* images,
instead cite the HDR-FLIP paper:
-[Paper](https://research.nvidia.com/publication/2021-05_HDR-FLIP) | [BibTeX](flip_evaluator/misc/HDRFLIP.txt)
+[Paper](https://research.nvidia.com/publication/2021-05_HDR-FLIP) | [BibTeX](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/HDRFLIP.txt)
Should your work use the FLIP tool in a more general fashion, please cite the Ray Tracing Gems II article:
-[Chapter](https://link.springer.com/chapter/10.1007%2F978-1-4842-7185-8_19) | [BibTeX](flip_evaluator/misc/FLIP.txt)
+[Chapter](https://link.springer.com/chapter/10.1007%2F978-1-4842-7185-8_19) | [BibTeX](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/FLIP.txt)
# Acknowledgements
We appreciate the following peoples' contributions to this repository:
diff --git a/flip_evaluator/cpp/README.md b/flip_evaluator/cpp/README.md
index d2891f3..197e6dd 100644
--- a/flip_evaluator/cpp/README.md
+++ b/flip_evaluator/cpp/README.md
@@ -17,7 +17,7 @@ and [HDR-FLIP](https://research.nvidia.com/publication/2021-05_HDR-FLIP) image e
It also holds code for the FLIP tool, presented in [Ray Tracing Gems II](https://www.realtimerendering.com/raytracinggems/rtg2/index.html).
Note that since v1.2, we use separated convolutions for the C++ and CUDA versions of FLIP. A note explaining those
-can be found [here](misc/separatedConvolutions.pdf).
+can be found [here](https://github.com/NVlabs/flip/blob/main/misc/separatedConvolutions.pdf).
With v1.3, we have switched to a single header [FLIP.h](FLIP.h) for easier integration into other projects.
@@ -28,12 +28,12 @@ Since v1.4, the majority of the code for the tool is contained in [FLIPToolHelpe
Copyright © 2020-2024, NVIDIA Corporation & Affiliates. All rights reserved.
-This work is made available under a [BSD 3-Clause License](../../LICENSE).
+This work is made available under a [BSD 3-Clause License](https://github.com/NVlabs/flip/blob/main/LICENSE).
-The repository distributes code for `tinyexr`, which is subject to a [BSD 3-Clause License](../misc/LICENSE-third-party.md#bsd-3-clause-license),
-and `stb_image`, which is subject to an [MIT License](../misc/LICENSE-third-party.md#mit-license).
+The repository distributes code for `tinyexr`, which is subject to a [BSD 3-Clause License](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LICENSE-third-party.md#bsd-3-clause-license),
+and `stb_image`, which is subject to an [MIT License](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LICENSE-third-party.md#mit-license).
-For individual contributions to the project, please confer the [Individual Contributor License Agreement](../misc/CLA.md).
+For individual contributions to the project, please confer the [Individual Contributor License Agreement](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/CLA.md).
For business inquiries, please visit our website and submit the form: [NVIDIA Research Licensing](https://www.nvidia.com/en-us/research/inquiries/).
@@ -64,7 +64,7 @@ For business inquiries, please visit our website and submit the form: [NVIDIA Re
- Usage: `flip[-cuda].exe --reference reference.{exr|png} --test test.{exr|png} [options]`, where the list of options can be seen by `flip[-cuda].exe -h`.
- Tested on Windows 10 version 22H2 and Windows 11 version 23H2 with CUDA 12.3. Compiled with Visual Studio 2022. If you use another version of CUDA, you will need to change the `CUDA 12.3` strings in the `CUDA.vcxproj` file accordingly.
- `flip_evaluator/tests/test.py` contains simple tests used to test whether code updates alter results.
-- Weighted histograms are output as Python scripts. Running the script will create a PDF version of the histogram. Notice that those scripts require `numpy` and `matplotlib`, both of which may be installed using pip. These are automantically installed when installing the Python version of FLIP (see [README.md](../python/README.md)).
+- Weighted histograms are output as Python scripts. Running the script will create a PDF version of the histogram. Notice that those scripts require `numpy` and `matplotlib`, both of which may be installed using pip. These are automantically installed when installing the Python version of FLIP (see [README.md](https://github.com/NVlabs/flip/blob/main/flip_evaluator/python/README.md)).
- The naming convention used for the FLIP tool's output is as follows (where `ppd` is the assumed number of pixels per degree,
`tm` is the tone mapper assumed by HDR-FLIP, `cstart` and `cstop` are the shortest and longest exposures, respectively, assumed by HDR-FLIP,
with `p` indicating a positive value and `m` indicating a negative value,
diff --git a/flip_evaluator/python/README.md b/flip_evaluator/python/README.md
index c7cb163..486c781 100644
--- a/flip_evaluator/python/README.md
+++ b/flip_evaluator/python/README.md
@@ -20,12 +20,12 @@ Similarly, it implements the FLIP tool, presented in [Ray Tracing Gems II](https
Copyright © 2020-2024, NVIDIA Corporation & Affiliates. All rights reserved.
-This work is made available under a [BSD 3-Clause License](../../LICENSE).
+This work is made available under a [BSD 3-Clause License](https://github.com/NVlabs/flip/blob/main/LICENSE).
-The repository distributes code for `tinyexr`, which is subject to a [BSD 3-Clause License](../misc/LICENSE-third-party.md#bsd-3-clause-license),
-and `stb_image`, which is subject to an [MIT License](../misc/LICENSE-third-party.md#mit-license).
+The repository distributes code for `tinyexr`, which is subject to a [BSD 3-Clause License](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LICENSE-third-party.md#bsd-3-clause-license),
+and `stb_image`, which is subject to an [MIT License](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LICENSE-third-party.md#mit-license).
-For individual contributions to the project, please confer the [Individual Contributor License Agreement](../misc/CLA.md).
+For individual contributions to the project, please confer the [Individual Contributor License Agreement](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/CLA.md).
For business inquiries, please visit our website and submit the form: [NVIDIA Research Licensing](https://www.nvidia.com/en-us/research/inquiries/).
@@ -38,7 +38,7 @@ For business inquiries, please visit our website and submit the form: [NVIDIA Re
- Usage (tool): `flip --reference reference.{exr|png} --test test.{exr|png} [--options]`, where the list of options can be seen by `flip -h`.
- Tested with pip 24.0, Python 3.11.8, pybind11 2.11.1, and C++20.
- FLIP runs on Windows, Linux (tested on Ubuntu 24.04), and OS X ($\ge$ 10.15), though its output might differ slightly between the different operative systems. The references used for `flip_evaluator/tests/test.py` are made for Windows. While the mean tests (means compared up to six decimal points) pass for each mentioned operative system, not all error map pixels are identical.
-- The code that implements FLIP metrics and the FLIP tool is available in [flip_evaluator/cpp/FLIP.h](https://github.com/NVlabs/flip/blob/main/cpp/FLIP.h) and [flip_evaluator/cpp/tool](https://github.com/NVlabs/flip/blob/main/cpp/tool), respectively. The relevant functions are called by the Python API using [pybind11](https://github.com/pybind/pybind11) (see [flip_evaluator/main.cpp](https://github.com/NVlabs/flip/blob/main/flip_evaluator/main.cpp)). The Python API is provided in `flip_evaluator/main.py`.
+- The code that implements FLIP metrics and the FLIP tool is available in [flip_evaluator/cpp/FLIP.h](https://github.com/NVlabs/flip/blob/main/flip_evaluator/cpp/FLIP.h) and [flip_evaluator/cpp/tool](https://github.com/NVlabs/flip/blob/main/flip_evaluator/cpp/tool), respectively. The relevant functions are called by the Python API using [pybind11](https://github.com/pybind/pybind11) (see [flip_evaluator/main.cpp](https://github.com/NVlabs/flip/blob/main/flip_evaluator/main.cpp)). The Python API is provided in `flip_evaluator/main.py`.
`flip_evaluator/tests/test.py` contains simple tests used to test whether code updates alter results.
- Weighted histograms are output as Python scripts. Running the script will create a PDF version of the histogram. Notice that those scripts require `numpy` and `matplotlib`, both of which are automatically installed during setup.
- The naming convention used for the FLIP tool's output is as follows (where `ppd` is the assumed number of pixels per degree,
@@ -87,7 +87,7 @@ For business inquiries, please visit our website and submit the form: [NVIDIA Re
**Example usage:**
To test the API, please inspect the `flip_evaluator/python/api_example.py` script. This shows how the available API commands may be used.
-Please note that not all capabilities of the tool is available through the Python API. For example, the exposure map is not output when running HDR-FLIP. For that, use the tool or the C++ API in [FLIP.h](https://github.com/NVlabs/flip/blob/main/cpp/FLIP.h).
+Please note that not all capabilities of the tool is available through the Python API. For example, the exposure map is not output when running HDR-FLIP. For that, use the tool or the C++ API in [FLIP.h](https://github.com/NVlabs/flip/blob/main/flip_evaluator/cpp/FLIP.h).
To test the tool, start a shell, navigate to `flip_evaluator/python` and try:
```
diff --git a/flip_evaluator/pytorch/README.md b/flip_evaluator/pytorch/README.md
index 05e6162..8cf8765 100644
--- a/flip_evaluator/pytorch/README.md
+++ b/flip_evaluator/pytorch/README.md
@@ -19,12 +19,12 @@ and [HDR-FLIP](https://research.nvidia.com/publication/2021-05_HDR-FLIP) image e
Copyright © 2020-2024, NVIDIA Corporation & Affiliates. All rights reserved.
-This work is made available under a [BSD 3-Clause License](../../LICENSE).
+This work is made available under a [BSD 3-Clause License](https://github.com/NVlabs/flip/blob/main/LICENSE).
-The repository distributes code for `tinyexr`, which is subject to a [BSD 3-Clause License](../misc/LICENSE-third-party.md#bsd-3-clause-license),
-and `stb_image`, which is subject to an [MIT License](../misc/LICENSE-third-party.md#mit-license).
+The repository distributes code for `tinyexr`, which is subject to a [BSD 3-Clause License](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LICENSE-third-party.md#bsd-3-clause-license),
+and `stb_image`, which is subject to an [MIT License](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/LICENSE-third-party.md#mit-license).
-For individual contributions to the project, please confer the [Individual Contributor License Agreement](../misc/CLA.md).
+For individual contributions to the project, please confer the [Individual Contributor License Agreement](https://github.com/NVlabs/flip/blob/main/flip_evaluator/misc/CLA.md).
For business inquiries, please visit our website and submit the form: [NVIDIA Research Licensing](https://www.nvidia.com/en-us/research/inquiries/).