Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

promote annotations' id field #233

Open
keighrim opened this issue Aug 14, 2024 · 0 comments
Open

promote annotations' id field #233

keighrim opened this issue Aug 14, 2024 · 0 comments

Comments

@keighrim
Copy link
Member

Since we are now discussing #228 that can permanently break the MMIF, I'd also like to bring another question of mine related to the id field of annotation objects.

We need id field to properly place and locate the annotation objects in the context of the MMIF format, but id values provide nothing intrinsic about the annotations themselves. I can imagine a id value is actually represent some intrinsic property of the type (e.g., a social/governmental identification number for a Person type), but that's not the way we use the field in the current MMIF format.

That said, I think the id field should be moved up to the top of annotation object, at the same level as @type field.

Plus, view objects have their id field at their top level, so annotations having id in a nested dict seems syntactically inconsistent.


(this could also be remotely related to this discussion #230 (comment) to try to better define the distinction between "metadata" and "property" of annotation types )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

1 participant