Woodwork provides a common typing namespace for using your existing DataFrames in Featuretools, EvalML, and general ML. A Woodwork DataFrame stores the physical, logical, and semantic data types present in the data. In addition, it can store metadata about the data, allowing you to store specific information you might need for your application.
Installation
Install with pip:
python -m pip install woodwork
or from the conda-forge channel on conda:
conda install -c conda-forge woodwork
Add-ons
Update checker - Receive automatic notifications of new Woodwork releases
python -m pip install "woodwork[updater]"
Example
Below is an example of using Woodwork. In this example, a sample dataset of order items is used to create a Woodwork DataFrame, specifying the LogicalType for five of the columns.
import pandas as pd
import woodwork as ww
df = pd.read_csv("https://oss.alteryx.com/datasets/online-retail-logs-2018-08-28.csv")
df.ww.init(name='retail')
df.ww.set_types(logical_types={
'quantity': 'Integer',
'customer_name': 'PersonFullName',
'country': 'Categorical',
'order_id': 'Categorical',
'description': 'NaturalLanguage',
})
df.ww
Physical Type Logical Type Semantic Tag(s)
Column
order_id category Categorical ['category']
product_id category Categorical ['category']
description string NaturalLanguage []
quantity int64 Integer ['numeric']
order_date datetime64[ns] Datetime []
unit_price float64 Double ['numeric']
customer_name string PersonFullName []
country category Categorical ['category']
total float64 Double ['numeric']
cancelled bool Boolean []
We now have initialized Woodwork on the DataFrame with the specified logical types assigned. For columns that did not have a specified logical type value, Woodwork has automatically inferred the logical type based on the underlying data. Additionally, Woodwork has automatically assigned semantic tags to some of the columns, based on the inferred or assigned logical type.
If we wanted to do further analysis on only the columns in this table that have a logical type of Boolean or a semantic tag of numeric we can simply select those columns and access a dataframe containing just those columns:
filtered_df = df.ww.select(include=['Boolean', 'numeric'])
filtered_df
quantity unit_price total cancelled
0 6 4.2075 25.245 False
1 6 5.5935 33.561 False
2 8 4.5375 36.300 False
3 6 5.5935 33.561 False
4 6 5.5935 33.561 False
.. ... ... ... ...
95 6 4.2075 25.245 False
96 120 0.6930 83.160 False
97 24 0.9075 21.780 False
98 24 0.9075 21.780 False
99 24 0.9075 21.780 False
As you can see, Woodwork makes it easy to manage typing information for your data, and provides simple interfaces to access only the data you need based on the logical types or semantic tags. Please refer to the Woodwork documentation for more detail on working with a Woodwork DataFrame.
Support
The Woodwork community is happy to provide support to users of Woodwork. Project support can be found in four places depending on the type of question:
- For usage questions, use Stack Overflow with the
woodworktag. - For bugs, issues, or feature requests start a Github issue.
- For discussion regarding development on the core library, use Slack.
- For everything else, the core developers can be reached by email at open_source_support@alteryx.com
Built at Alteryx
Woodwork is an open source project built by Alteryx. To see the other open source projects we’re working on visit Alteryx Open Source. If building impactful data science pipelines is important to you or your business, please get in touch.
7 maintainers
Metadata
7 maintainers
Release files for woodwork 0.31.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| woodwork-0.31.0.tar.gz | 178.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| woodwork-0.31.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 393.7 kB
Release files / woodwork-0.31.0.tar.gz
| Download URL | woodwork-0.31.0.tar.gz |
|---|---|
| Size | 178.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ef82af1d5b6525b02efe6417c574c810cfdcc606cb266bd0d7fb17a1d066b67
|
|
BLAKE2b-256 checksum How to use checksums |
278d49a9350004be051057561e8f0bd14c40e5fbc61e1f5d7261d3415d54cd19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
Release files / woodwork-0.31.0-py3-none-any.whl
| Download URL | woodwork-0.31.0-py3-none-any.whl |
|---|---|
| Size | 215.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5cb3370553b5f466f8c8599b1bf559584dc0b798cc1f2da26bbd7029d256c6f9
|
|
BLAKE2b-256 checksum How to use checksums |
49a2bf83836640086a518c6b0c361765aaaf37b57e127844dd57f6c7e9e11153
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
