Skip to content

Commit a6be3a8

Browse files
authored
Demonstration for readme (#45)
1 parent 197b7dc commit a6be3a8

File tree

2 files changed

+1474
-1
lines changed

2 files changed

+1474
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ pip install git+https://github.com/sign-language-processing/pose-evaluation.git
1818
```
1919

2020
Create a metric:
21+
2122
```python
2223
from pose_evaluation.metrics.distance_metric import DistanceMetric
2324
from pose_evaluation.metrics.dtw_metric import DTWDTAIImplementationDistanceMeasure
@@ -38,18 +39,32 @@ DTWp = DistanceMetric(
3839
```
3940

4041
Evaluate two pose sequences:
42+
4143
```python
4244
from pose_format import Pose
4345

4446
with open("hypothesis.pose", "rb") as f:
4547
hypothesis = Pose.read(f)
46-
48+
4749
with open("reference.pose", "rb") as f:
4850
reference = Pose.read(f)
4951

5052
DTWp.score(hypothesis, reference)
5153
```
5254

55+
### Demo Notebook
56+
57+
For a demonstration of how to use the package, see the [demo notebook](examples\Pose_Evaluation_Example.ipynb)
58+
<a target="_blank" href="https://colab.research.google.com/github/github.com/sign-language-processing/pose-evaluation/examples/Pose_Evaluation_Example.ipynb">
59+
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
60+
</a>
61+
62+
Demonstrates:
63+
64+
- How to reconstruct the metrics from our paper.
65+
- How to use them to score poses, with signatures.
66+
- How to score poses with different lengths, missing/undetected keypoints, or different keypoint formats.
67+
5368
### Contributing
5469

5570
Please make sure to run `make format` before submitting a pull request.

0 commit comments

Comments
 (0)