Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paddymul/df_cereal
playground for dataframe serialization
https://github.com/paddymul/df_cereal
Last synced: 9 days ago
JSON representation
playground for dataframe serialization
- Host: GitHub
- URL: https://github.com/paddymul/df_cereal
- Owner: paddymul
- License: bsd-3-clause
- Created: 2024-03-14T18:49:01.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-23T14:42:08.000Z (9 months ago)
- Last Synced: 2024-11-29T16:17:42.778Z (26 days ago)
- Language: Jupyter Notebook
- Size: 3.32 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# DF_Cereal - Serialization testing ground
This is a stripped down repo to test different methods of dataframe serialization. It aims to be a referencer implementation for serializing dataframes with pyarrow.
Dataframe serialization is hard, and it is the source of performance regresssions. Arrow seems to be the way forward for dataframe libraries and for dataframe serialization. This project is meant to be a colaborative reference for library authors who want to do high performance serialization.
## Planned features include
* A repo that demonstrates different ways to serialize dataframes, with MVP implementations that are easy to adapt
* Benchmarks for different serialization techniques
* Tests for all of this
* Examples of more complex dataframe constructs, and how they appear in JS. Multi-indexes, TimeStamps, structures
* Simple documentation that is easy to follow
## notes
This repo is built on top of stripped down [buckaroo](https://github.com/paddymul/buckaroo) repo. Some buckaroo artifacts might pop out here and there.
## Development installation
For a development installation:
```bash
git clone https://github.com/paddymul/df_cereal.git
cd df_cereal
#we need to build against 3.6.5, jupyterlab 4.0 has different JS typing that conflicts
# the installable still works in JL4
pip install build twine pytest sphinx polars mypy jupyterlab==3.6.5 pandas-stubs
pip install -ve .
```
Enabling development install for Jupyter notebook:
Enabling development install for JupyterLab:
```bash
jupyter labextension develop . --overwrite
```
Note for developers: the `--symlink` argument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows.
`
### Developing the JS side
There are a series of examples of the components in [examples/ex](./examples/ex).
Instructions
```bash
npm install
npm run dev
```
## Contributions
We :heart: contributions.
Have you had a good experience with this project? Why not share some love and contribute code, or just let us know about any issues you had with it?
We welcome issue reports [here](../../issues); be sure to choose the proper issue template for your issue, so that we can be sure you're providing the necessary information.