[ENH] draft design for refactoring datatypes module - classes#6033
Closed
[ENH] draft design for refactoring datatypes module - classes#6033
datatypes module - classes#6033Conversation
Collaborator
Author
|
Note to self: this would also solve the issue of documenting the mtype specifications, if we (a) do it in the class docstring, and (b) list them in the API reference. A minor issue is displaying the naming of mtypes, though this can be taken care of in the first line of the class docstring. |
Contributor
|
Since |
Collaborator
Author
|
hmm - good idea! |
Collaborator
Author
|
do you want to try copy this, or should I do that? |
Contributor
|
You can copy it - is it possible after wards for me to work on the your branch that you made? |
Collaborator
Author
|
sure. Let me adapt it, and then you try to merge with your |
fkiraly
added a commit
to sktime/skpro
that referenced
this pull request
Sep 7, 2024
This PR refactors the data type specifications and converters to classes. Implements sktime/sktime#3512, related to sktime/sktime#2957. Contains: * a base class for mtypes, `BaseDatatype`, to replace the more ad-hoc dictionary design * a complete refactor of the `Table` mtype submodule to this interface * a base class for converters, `BaseConverter`, also replacing a dictionary based design * a partial refactor of the `Table` related converters to this interface * a full refactor of the public framework module with `check` and `convert` logic, in `datatypes`, to allow extensibility with this design Partial mirror in `skpro` of sktime/sktime#6033
fkiraly
added a commit
to sktime/skpro
that referenced
this pull request
Sep 8, 2024
This PR refactors the data type specifications and converters to classes. Related: sktime/sktime#3512, related to sktime/sktime#2957. Contains: * a base class for datatype examples, `BaseExample`, to replace the more ad-hoc dictionary design * a complete refactor of the `Table` and `Proba` mtype submodules to this interface * a full refactor of the public framework module with `get_example` logic, in `datatypes`, to allow extensibility with this design Partial mirror in `skpro` of sktime/sktime#6033
Collaborator
Author
|
superseded by #7161 |
fkiraly
added a commit
that referenced
this pull request
Oct 14, 2024
…ecords (#7161) This PR carries out a refactor of the `datatypes` module to `scikit-base` classes and data records, with the following benefits: * modularity and extensibility * the classes can be used as records in the documentation to store information about the container specification * programmatic soft dependency isolation, e.g., of data containers requiring soft dependencies such as `polars`, `dask`, `xarray`, `gluonts`, etc. The refactor parallels that in `skpro`, and replaces the earlier attempt in #6033. Towards #3512.
benHeid
pushed a commit
that referenced
this pull request
Feb 15, 2025
…ecords (#7161) This PR carries out a refactor of the `datatypes` module to `scikit-base` classes and data records, with the following benefits: * modularity and extensibility * the classes can be used as records in the documentation to store information about the container specification * programmatic soft dependency isolation, e.g., of data containers requiring soft dependencies such as `polars`, `dask`, `xarray`, `gluonts`, etc. The refactor parallels that in `skpro`, and replaces the earlier attempt in #6033. Towards #3512.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Implements #3512, related to #2957
This adopts the design proposed in the issue, with a class for mtypes, and a class for conversions, both being
BaseObject.The design is meant ot make the
datatypesmodule more extensible, and making it easier to manage soft dependencies in data type such asxarray,polars, ortemporianEventSet(FYI @ianspektor, @achoum).Currently in draft state for review, contains only the proposed class structure and refactor of a single mtype (
pd.DataFrame),FYI @sktime/core-developers