Skip to content

Commit

Permalink
enable hypothesis. update docs to include askpbs and hypothesis info
Browse files Browse the repository at this point in the history
  • Loading branch information
ejolly committed Dec 16, 2022
1 parent 786c590 commit 03337f4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
7 changes: 4 additions & 3 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
# Learn more at https://jupyterbook.org/customize/config.html

title: Py-Feat
author: Eshin Jolly, Jin Hyun Cheong, Tiankang Xie
author: Eshin Jolly, Jin Hyun Cheong, Tiankang Xie, Luke J. Chang
copyright: "2022"
logo: "images/logo/pyfeat_logo_small.png"
exclude_patterns : [ README.md, _build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints"]
exclude_patterns : [ README.md, _build, Thumbs.db, .DS_Store,
"**.ipynb_checkpoints", "**/*/figure.ipynb"]

execute:
execute_notebooks : off # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off")
Expand Down Expand Up @@ -36,7 +37,7 @@ html:
home_page_in_navbar : false # Whether to include your home page in the left Navigation Bar
baseurl : "" # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/
comments:
hypothesis : false
hypothesis : true
utterances : false

# Add GitHub buttons to your book
Expand Down
9 changes: 7 additions & 2 deletions docs/pages/usage_guide.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Usage Tips and Known Issues
# Tips, Community, and Known Issues

Here are few general guidelines and known issues when using `py-feat`. We are always actively trying to improve these issues and make the toolbox easier to use. Please help us out by contributing on github!

Always spot-check your detections! While we've done our best to thoroughly test, benchmark, and document all the [pre-trained models](models.md) included in Py-Feat it's always possible that real-world images and videos reveal a quirk or limitation of an otherwise high-performing detector.
**Always spot-check your detections! While we've done our best to thoroughly test, benchmark, and document all the [pre-trained models](models.md) included in Py-Feat it's always possible that real-world images and videos reveal a quirk or limitation of an otherwise high-performing detector.**

## Community
- [Hypothesis:](https://web.hypothes.is/) a social annotation tool that allows you post and read posts from other users who have visited this site. Click on the `<` on the top right of any page to get started.
- [Discourse Community:](https://www.askpbs.org/c/py-feat/26>) a Stack Overflow like forum where you can view, contribute, and vote on FAQs regarding ``py-feat`` usage. Please ask questions here first so other users can benefit from the answers!
- [Open a Github issue](https://github.com/cosanlab/py-feat/issues>) for all code related problems. You can do so by click the github icon on the top of any page.

## Known issues
- Currently when performing detections and using `batch_size > 1`, AU models output slightly different values. This is in part due to how Py-Feat integrates the underlying detectors and we are actively working to fix this. You can follow [this issue](https://github.com/cosanlab/py-feat/issues/128) for more details.
Expand Down

0 comments on commit 03337f4

Please sign in to comment.