Changelog¶
Beta¶
v0.4.0 - 2022-11-03¶
Software Changes:
- ✨ Bump
datasets
tov0.0.6
, Addcalifornia_housing
androofworld20
https://github.com/srlearn/relational-datasets/pull/28
Documentation Changes:
- ✨ Dataset loading recommendations. All pages under "Dataset descriptions" now have Python and Julia tabs recommending how to load the latest version of each dataset https://github.com/srlearn/relational-datasets/pull/30
CI Changes:
- 🔧 Bump codecov-action to
v3
https://github.com/srlearn/relational-datasets/pull/29 - 🔧 Set
pythonpublish.yml
to usepypi-publish
https://github.com/srlearn/relational-datasets/pull/31
v0.3.0 - 2022-06-20¶
Software Changes:
- Append the name of the variable to the discrete variable value in
from_numpy
https://github.com/srlearn/relational-datasets/pull/25
Documentation Changes:
- Add
mkdocstrings-python
dependency https://github.com/srlearn/relational-datasets/pull/27 - Drop
handler
indocs/api/*
for generating docstrings https://github.com/srlearn/relational-datasets/pull/27 - Update cells by running notebooks https://github.com/srlearn/relational-datasets/pull/26
v0.2.2 - 2021-12-04¶
Software Changes:
- Add multiclass support to
convert.from_numpy
Documentation:
- Add notebook with overview on converting multiclass vector datasets
Testing:
- Add tests for
convert.from_numpy
v0.2.1 - 2021-12-01¶
Software Changes:
- Add
drug_interactions
andtoy_machines
datasets - Add
v0.0.5
as the latestsrlearn/datasets
release
v0.2.0 - 2021-08-27¶
Software Changes:
- Add
convert
module withfrom_numpy
implementation to convert binary classification and regression datasets based on ordinal encodings. - Fix type annotations in
relational_datasets.request
- Fix type annotations in
relational_datasets.types
Documentation:
- Add tutorial for converting vector/propositional datasets to relational
- Add
mkdocs
dependency:pymdownx.tasklist
- Add
binder
andcolab
launch badges to Jupyter notebook tutorials
Testing:
- Add
lgtm
build step + README badge - Add
codecov
build step + README badge - Add
numpy>=1.20.0
as an optional setup target, and test against it (this is the earliest version ofnumpy
where type annotations formypy
seem to be consistently available)
Pre-Alpha¶
v0.1.1 - 2021-08-10¶
Software Changes:
- Bump default dataset version:
v0.0.3
→v0.0.4
. - Between
v0.0.3
andv0.0.4
ofsrlearn/datasets
, all zipfiles now have the version number appended (e.g.toy_cancer_v0.0.4.zip
). Add logic to request the correct filename from GitHub. - Add
deserialize_zipfile
function, split out code for pulling zipfile content from theload
method. - Add private
_make_file_path
function to handle where zipfiles are stored on a user's filesystem. - Move
RelationalDataset
type intorelational_datasets/types.py
- Fix
hayesall/relational_datasets
→srlearn/relational_datasets
insetup.py
- Clarify
typing.Optional
in function signatures where default file paths are allowed. - Add
__version__
to the main__init__
, soprint(relational_datasets.__version__)
is valid.
Documentation:
- Add
mkdocs
builds with each push to themain
branch. - Add
requirements_dev.txt
with requirements to build documentation. - Add
docs/build._docs.py
to build a Downloads page and an overview of each dataset pulled from thesrlearn/datasets
repository. - Add
docs/notebooks/
directory for literate tutorials- Add
00_loading_and_fetching.ipynb
- Add
- Pages for functions and types:
types.RelationalDataset
request.deserialize_zipfile
request.fetch
request.latest_version
request.load
v0.1.0 - 2021-07-21¶
Release basic specification:
load(name: str, version: str = "", fold: int = 1) -> Tuple[RelationalDataset, RelationalDataset]
: Load examples and facts for a dataset/version/foldfetch(name: str, version: str = "") -> str
: Download and cache an archive locallyget_data_home(data_home=None) -> str
: Get the path to the cache directoryclear_data_home(data_home=None) -> None
: Remove the cache directorylatest_version() -> str
: Check latest version of datasets on GitHub
Last update:
November 3, 2022