Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ pip install git+https://github.com/sign-language-processing/pose-evaluation.git
```

Create a metric:

```python
from pose_evaluation.metrics.distance_metric import DistanceMetric
from pose_evaluation.metrics.dtw_metric import DTWDTAIImplementationDistanceMeasure
Expand All @@ -38,18 +39,32 @@ DTWp = DistanceMetric(
```

Evaluate two pose sequences:

```python
from pose_format import Pose

with open("hypothesis.pose", "rb") as f:
hypothesis = Pose.read(f)

with open("reference.pose", "rb") as f:
reference = Pose.read(f)

DTWp.score(hypothesis, reference)
```

### Demo Notebook

For a demonstration of how to use the package, see the [demo notebook](examples\Pose_Evaluation_Example.ipynb)
<a target="_blank" href="https://colab.research.google.com/github/github.com/sign-language-processing/pose-evaluation/examples/Pose_Evaluation_Example.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>

Demonstrates:

- How to reconstruct the metrics from our paper.
- How to use them to score poses, with signatures.
- How to score poses with different lengths, missing/undetected keypoints, or different keypoint formats.

### Contributing

Please make sure to run `make format` before submitting a pull request.
Expand Down
Loading
Loading