[](https://github.com/ambv/black)
# ayx-learn
A foundation of [scikit-learn](https://scikit-learn.org/stable/) compatible data science tools, such as Transformers, that both Alteryx Assisted Modeling and Code Fee Tools are built on.
## Source code organization
` . ├── README.md ├── ayx_learn: Source code for the ayx_learn package. │ ├── cmd: CLI commands that enable transformers and other functions to be used directly from the command-line. │ ├── transformers: Transformer source code. │ └── utils: Utility functions, such as validation. ├── docs: Sphinx documentation. ├── examples: CLI examples that use ayx_learn/cmd and DVC. ├── notebooks: Jupyter notebooks. ├── requirements-dev.txt: Requirements for development env. ├── requirements.txt: Requirements for building and running in a production env. ├── setup.py ├── tests │ └── unit: pytest unit tests. └── tox.ini: Ini file for tox. `
## Code standards
ayx-learn follows the [Alteryx Python Code Standards](https://alteryx.quip.com/qR3kAG4OA32X/Python-Code-Standards)
## Error handling and Logging
Errors/exceptions in ayx-learn follow the Message and Raise and Transformer patterns described in the blog at [Exceptional logging of exceptions in Python](https://www.loggly.com/blog/exceptional-logging-of-exceptions-in-python/).
Following the recommendations at, [Configuring Logging for a Library](https://docs.python.org/3/howto/logging.html#configuring-logging-for-a-library), a NullHandler has been initialized at ayx_learn module scope. Clients of ayx-learn can easily provide a logging handler that will override the NullHandler by initializing a handler in the client. E.g.
` import logging logging.basicConfig(filename='example.log',level=logging.DEBUG) `
## Testing
Unit tests are written using [pytest](https://docs.pytest.org/) and are located in ./tests/unit.
[tox](https://tox.readthedocs.io/) can be used for creating a virtualenv and automatically running the pytest unit tests.
## Examples
A set of CLI examples based on ayx_learn/cmd that use [DVC](https://dvc.org/) for managing data, creating, and running pipelines.
Usage
` cd examples/titanic dvc pull dvc repro step_2.csv.dvc `
To clean-up data files
` dvc remove -o *.dvc `
## Documentation
ayx-learn follows the [Alteryx Python Documentation Standards](https://alteryx.quip.com/bFgiAZThHaJv/Python-Documentation-Standards).
See [README](docs/README.md).
1 maintainer
Metadata
1 maintainer
Release files for ayx-learn 0.0.1.136658
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ayx_learn-0.0.1.136658.tar.gz | 12.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ayx_learn-0.0.1.136658-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 43.7 kB
Release files / ayx_learn-0.0.1.136658.tar.gz
| Download URL | ayx_learn-0.0.1.136658.tar.gz |
|---|---|
| Size | 12.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
59674753a5e60700a816905706bb7ebeccffc23185937ada2db24592dd09cbd3
|
|
BLAKE2b-256 checksum How to use checksums |
5c3948ede95f439d87ec1467ff14bf8e8ced5f53a611ad43a3c8882c7603ebc4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/35.0.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.5.2
|
Release files / ayx_learn-0.0.1.136658-py3-none-any.whl
| Download URL | ayx_learn-0.0.1.136658-py3-none-any.whl |
|---|---|
| Size | 30.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f683081c1450b08ff1b5982457517874a7cb2394d547d10ae811634c5b218bfc
|
|
BLAKE2b-256 checksum How to use checksums |
acf576a3f13425cf0b283f8d4d4280d161a512e761e43d450c76d8000fd63012
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/35.0.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.5.2
|
](https://github.com/ambv/black){kind=link}