Skip to content

Commit

Permalink
Switch sphinx to dirhtml mode
Browse files Browse the repository at this point in the history
  • Loading branch information
mehaase committed Sep 14, 2023
1 parent 717d0ce commit 95d7fa0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
- name: Install dependencies
run: poetry install
- name: Build HTML docs
run: poetry run sphinx-build -M html docs docs/_build -W --keep-going
run: poetry run sphinx-build -M dirhtml docs docs/_build -W --keep-going
- name: Upload HTML docs
uses: actions/upload-artifact@v3
with:
Expand Down
7 changes: 4 additions & 3 deletions docs/definitions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This page defines the key terms used throughout our research.
Precision
---------

**Precision is the ratio of true positives to positive results matched by an analytic.**
**Precision is the fraction of relevant malicious events among all events matched by an analytic.**

High precision analytics create fewer false positives. Precision is high at lower levels
of the pyramid (e.g. file hashes) but can be challenging for analytics higher on the
Expand All @@ -19,7 +19,7 @@ pyramid.
Recall
------

**Recall is the ratio of true positives to total events matched by an analytic.**
**Recall is the fraction of malicious events that are matched by an analytic.**

High recall analytics are less likely to miss malicious activity. There is often a
tradeoff between precision and recall: as one increases, the other decreases. This
Expand All @@ -30,7 +30,8 @@ getting overwhelmed with false positives.

Robustness
----------
**Robustness measures the effort needed by an adversary to evade an analytic**

**Robustness measures the effort needed by an adversary to evade an analytic.**

Robustness is crucial for the effectiveness of an analytic, and is the focus of the
Summiting the Pyramid project. Robustness is directly related to the cost required by an
Expand Down

0 comments on commit 95d7fa0

Please sign in to comment.