Add field_list and data methods to archives #412
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 tasks
btjanaka
added a commit
that referenced
this pull request
Nov 10, 2023
## Description <!-- Provide a brief description of the PR's purpose here. --> Due to the new `data` method (#412), `as_pandas` is no longer necessary, as `data` provides more flexible options for accessing archive data, and it is also able to return dataframes by passing `return_type="pandas"`. This PR thus deprecates `as_pandas`. Because this is a fairly popular method, I have kept the method and raised a RuntimeError whenever it is called; however, I anticipate removing the method entirely in the future. I also considered keeping `as_pandas` as an alias to `data(return_type="pandas")`, but this would require changing the parameters of `as_pandas` since `data` takes in `fields` rather than `include_solutions` and `include_metadata`. Removing `as_pandas` entirely makes it clear that it has been deprecated. ## TODO <!-- Notable points that this PR has either accomplished or will accomplish. --> - [x] Introduce a `data()` method that returns the archive data in many forms - [x] Remove `as_pandas()` since `data(return_type="pandas")` now fulfills this role - [x] Replace as_pandas test with data test - [x] Fix usage of as_pandas in tests - [x] Remove as_pandas in tutorials ## Questions <!-- Any concerns or points of confusion? --> ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The overall goal of this PR is to make it easier to access the data contained in each archive.
TODO
data()method that returns the archive data in many forms -> this method primarily passes calls toArrayStore.datafield_listmethod that shows the list of all fields in the archiveQuestions
Status
CONTRIBUTING.md
yapfpytestpylintHISTORY.md