Skip to content

Commit

Permalink
Apply some suggestions outright
Browse files Browse the repository at this point in the history
Co-authored-by: sfmig <[email protected]>
  • Loading branch information
niksirbi and sfmig authored Nov 28, 2024
1 parent b36f5c5 commit 008f5ea
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
10 changes: 4 additions & 6 deletions docs/source/community/mission-scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,13 @@ about the individual's posture.

Animal tracking frameworks such as [DeepLabCut](dlc:) or [SLEAP](sleap:) can
generate these representations from video data by detecting body parts and
tracking them across frames. In the context of `movement`, we refer to the
resulting tracks according to their respective representations—for
example, pose tracks, bounding boxes' tracks, or motion tracks in general.
tracking them across frames. In the context of `movement`, we refer to these trajectories as _tracks_: we use _pose tracks_ to refer to the trajectories of a set of keypoints, _bounding boxes' tracks_ to refer to the trajectories of bounding boxes' centroids, or _motion tracks_ in the more general case.

Our vision is to present a **consistent interface for motion tracks** paired
with **modular and accessible analysis tools**. We aim to accommodate data
Our vision is to present a **consistent interface for representing motion tracks** along
with **modular and accessible analysis tools**. We aim to support data
from a range of animal tracking frameworks, in **2D or 3D**, tracking
**single or multiple individuals**. As such, `movement` can be considered as
downstream of tools like DeepLabCut and SLEAP. The focus is on providing
operating downstream of tools like DeepLabCut and SLEAP. The focus is on providing
functionalities for data cleaning, visualization, and motion quantification
(see the [Roadmap](target-roadmaps) for details).

Expand Down
2 changes: 1 addition & 1 deletion docs/source/community/roadmaps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This page outlines **current development priorities** and aims to **guide core developers** and to **encourage community contributions**. It is a living document and will be updated as the project evolves.

The roadmaps are **not meant to limit** `movement` features, as we are open to suggestions and contributions. Join our [Zulip chat](movement-zulip:) to share your ideas. We will take community demand and feedback into account when planning future releases.
The roadmaps are **not meant to limit** `movement` features, as we are open to suggestions and contributions. Join our [Zulip chat](movement-zulip:) to share your ideas. We will take community feedback into account when planning future releases.

## Long-term vision
The following features are being considered for the first stable version `v1.0`.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ to process the tracks generated by these tools.
``movement`` aims to provide a consistent, modular interface for analyzing
motion tracks, enabling steps such as data cleaning, visualization,
and motion quantification. We aim to support all popular animal tracking
frameworks and common file formats.
frameworks and file formats.

Find out more on our [mission and scope](target-mission) statement and our [roadmap](target-roadmaps).

Expand Down

0 comments on commit 008f5ea

Please sign in to comment.