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

Remove metadata in favor of custom fields #420

Merged
merged 7 commits into from
Nov 16, 2023
Merged

Remove metadata in favor of custom fields #420

merged 7 commits into from
Nov 16, 2023

Conversation

btjanaka
Copy link
Member

@btjanaka btjanaka commented Nov 16, 2023

Description

We plan to add the ability to specify custom fields in pyribs archives. This PR thus removes metadata, which are a current substitute for custom fields. Custom fields will also support object dtypes, meaning metadata can still be recovered by specifying a metadata field with object dtype.

While this change is backwards-incompatible, I believe it is beneficial for the simplicity of the library. Currently, metadata is the only array that is an object array, making it more difficult to save next to arrays like the objective and measures arrays. Furthermore, metadata currently has a complex defaulting system since it is usually None.

TODO

  • Remove metadata from codebase
  • Remove metadata from tests
  • Fix docstrings

Questions

Status

  • I have read the guidelines in
    CONTRIBUTING.md
  • I have formatted my code using yapf
  • I have tested my code by running pytest
  • I have linted my code with pylint
  • I have added a one-line description of my change to the changelog in
    HISTORY.md
  • This PR is ready to go

@btjanaka btjanaka changed the title Remove metadata in favor of custom fields Remove metadata from archives Nov 16, 2023
@btjanaka btjanaka changed the title Remove metadata from archives Remove metadata in favor of custom fields Nov 16, 2023
@btjanaka btjanaka merged commit 66b8eb9 into master Nov 16, 2023
17 checks passed
@btjanaka btjanaka deleted the metadata branch November 16, 2023 10:43
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.

1 participant