Merge pull request #289 from pykale/landmark_uncertainty_readme_change

update readme to say functional code is on another branch
pykale · Jan 20, 2022 · e42b4ec · e42b4ec
2 parents d20dfd9 + 5b8f077
commit e42b4ec
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/examples/landmark_uncertainty/README.md b/examples/landmark_uncertainty/README.md
@@ -1,5 +1,7 @@
 # Uncertainty Estimation in Landmark Localization
 
+**IMPORTANT:** This is the clean branch of Pykale. Fully functional and reproducable code can be found on [this branch](https://github.com/pykale/pykale/tree/landmark_uncertainty/examples/landmark_uncertainty). It is not merged yet due to low test coverage.
+
 ## 1. Description
 
 In this example we implement the methods from [Uncertainty Estimation for Heatmap-based Landmark Localization](placeholder_link). The method is Quantile Binning, which bins landmark predictions by any continuous uncertainty estimation measure. We assign each bin estimated localization error bounds. We can use these bins to filter out the worst predictions, or identify the likely best predictions.