Skip to content

Schema.Metadata needs a better name #1843

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

Closed
TomFinley opened this issue Dec 6, 2018 · 1 comment · Fixed by #2712
Closed

Schema.Metadata needs a better name #1843

TomFinley opened this issue Dec 6, 2018 · 1 comment · Fixed by #2712
Assignees
Labels
API Issues pertaining the friendly API need info This issue needs more info before triage question Further information is requested

Comments

@TomFinley
Copy link
Contributor

"Metadata" is perhaps not the best name for what we currently call metadata.

First, what is it: what we call Metadata is meant to suggest not just any metadata, but that data that we consider auxiliary, or at most ancillary. (So for example, slot names are in metadata, because not everything will have names for each slot. But sometimes they will, and we need a place to keep that.)

The trouble with the name "metadata" is that it means literally everything but the data. But this is inaccurate: there are lots of things that are data about the data (e.g., the types, the vector sizes, the names of columns) that we definitely do not want to keep in the metadata structure (since they're absolutely required information), but that is "metadata" in the strict linguistic sense of the word.

The only name suggested as an alternative that I am aware of is "annotations." I am fine with the name annotations. Perhaps we could come up with a better name. I'll leave this open for a bit, and unless people object we can rename metadata annotations.

@TomFinley TomFinley added question Further information is requested API Issues pertaining the friendly API labels Dec 6, 2018
TomFinley referenced this issue in dotnet/apireviews Dec 12, 2018
@Zruty0
Copy link
Contributor

Zruty0 commented Dec 18, 2018

I am fine with 'annotations' as a property name (as in, schema[column].Annotations.GetValue("foo", ref foo)).

As for the class name, I think neither Metadata nor Annotations are good names: they reflect what the object is used for, not what it is. And the metadata is, essentially, 'almost a row', or 'a property bag'.

So, maybe PropertyBag, or ValueCollection or something like that?..

@shauheen shauheen added the need info This issue needs more info before triage label Jan 28, 2019
@eerhardt eerhardt self-assigned this Feb 15, 2019
eerhardt added a commit to eerhardt/machinelearning that referenced this issue Feb 25, 2019
eerhardt added a commit to eerhardt/machinelearning that referenced this issue Feb 25, 2019
eerhardt added a commit to eerhardt/machinelearning that referenced this issue Feb 26, 2019
eerhardt added a commit that referenced this issue Feb 26, 2019
* Rename DataView Metadata to Annotations.

Fix #1843
Fix #2297
@ghost ghost locked as resolved and limited conversation to collaborators Mar 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
API Issues pertaining the friendly API need info This issue needs more info before triage question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants