Skip to content

Commit

Permalink
add disclaimer readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ryichando committed Jan 6, 2025
1 parent e8553c0 commit af9031e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,4 @@ _skipped.node
docs/_*
docs/parameters.rst
docs/logs.rst
private/vast-dev
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,10 +299,15 @@ To ensure greater transparency, we implemented GitHub Actions to run many of our

Also, we apply small jitters to the position of objects in the scene 🔄, so at each run, the scene is slightly different.

> [!NOTE]
> We are constantly updating our algorithms 🔄, which may lead to some failures ❌.
> Of course, we push our code after quick testing ✅, but still, some failures may occur 🚫 in this long stress test.
> This proves the importance of these stress tests 🧪, and these results more clearly demonstrate the reliability of our solver 💪, not by simply providing a single success case as a showcase 🎯.
#### ⚠️ Disclaimer

<img align="right" width="150" src="./asset/image/snag-failure.jpg">
We are constantly updating our algorithms 🔄, which may lead to some failures ❌.
Of course, we push our code after a few tests ✅, but still, some failures may occur 🚫 in this long stress test.
Please understand that this stress test is designed for this purpose 🎯.
A failure can be also due to excessively difficult test cases 🔬.
An example is shown in the right inset 👉.
We also update scene settings to avoid such unreasonable cases 🔧.

## 💨 Getting Started

Expand Down
Binary file added asset/image/snag-failure.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit af9031e

Please sign in to comment.