[](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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ayx_learn-0.0.1.121789.tar.gz.
File metadata
- Download URL: ayx_learn-0.0.1.121789.tar.gz
- Upload date:
- Size: 13.3 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3a201153932d696896267d0b06886e624a23d9bb673dceb3edbd6c3a61989c9b
|
|
| MD5 |
927a0d70ac62587d140d2ee8db93a78b
|
|
| BLAKE2b-256 |
8c13b9481d60d486ff559e6f3f7bc05931504622133d5552909294ab0c85c1a6
|
File details
Details for the file ayx_learn-0.0.1.121789-py3-none-any.whl.
File metadata
- Download URL: ayx_learn-0.0.1.121789-py3-none-any.whl
- Upload date:
- Size: 31.3 kB
- Tags: Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc89e79aae80e11905061cf2eba651e4237b85340c214a0ee54e9cca2c7e51d5
|
|
| MD5 |
0cd59c84f04edd3d0e733c8684f1886a
|
|
| BLAKE2b-256 |
0c104b7aa8e238d587ea0fa7d7e7426d664e75c7311ee5edd4e04c96750c31aa
|
](https://github.com/ambv/black){kind=link}