Skip to content

Add Data Format Documentation#1046

Merged
subdavis merged 2 commits into
mainfrom
misc-docs-updates
Nov 16, 2021
Merged

Add Data Format Documentation#1046
subdavis merged 2 commits into
mainfrom
misc-docs-updates

Conversation

@subdavis
Copy link
Copy Markdown
Contributor

This seems generally useful to have and will help both internal and external collaborators work with DIVE.

Comment thread docs/DataFormats.md
Comment on lines +15 to +24
``` typescript
interface TrackData {
trackId: TrackId;
meta: StringKeyObject;
attributes: StringKeyObject;
confidencePairs: Array<ConfidencePair>;
features: Array<Feature>;
begin: number;
end: number;
}
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really helpful without defining what Feature and ConfidencePair are? I know you can go to the link below and the confidencePair/Feature definitions are right there. Confidence Pair I think can be simplified inline if required. Feature though is probably the important thing people care about if they make it to this page.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. Let's reproduce the other interfaces here.

@subdavis subdavis requested a review from BryonLewis November 16, 2021 16:55
@subdavis subdavis merged commit 1247282 into main Nov 16, 2021
@subdavis subdavis deleted the misc-docs-updates branch November 16, 2021 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants