Skip to main content

1 folk folk_icon

PyPI-Status PyPI-Versions Build-Status Codecov LICENCE

Folksy experiment management for Machine Learning.

# TBD

1.1 Installation

pip install folk

1.2 Basic Use

folk is divided into several sub-modules by functionality:

1.3 Contributing

Package author and current maintainer is Shay Palachy (shay.palachy@gmail.com); You are more than welcome to approach him for help. Contributions are very welcomed.

1.3.1 Installing for development

Clone:

git clone git@github.com:shaypal5/folk.git

Install in development mode:

cd folk
pip install -e .

1.3.2 Running the tests

To run the tests use:

pip install pytest pytest-cov coverage
cd folk
pytest

1.3.3 Adding documentation

The project is documented using the numpy docstring conventions, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings. When documenting code you add to this project, follow these conventions.

Additionally, if you update this README.rst file, use python setup.py checkdocs (or pipenv run the same command) to validate it compiles.

1.4 Credits

Created by Shay Palachy (shay.palachy@gmail.com).

Metadata

Release files for folk 0.0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for folk 0.0.9
File Interpreter ABI Platform Actions
folk-0.0.9-py2.py3-none-any.whl Python 2, Python 3 none any Details for folk-0.0.9-py2.py3-none-any.whl

Release files / folk-0.0.9-py2.py3-none-any.whl

Download URL folk-0.0.9-py2.py3-none-any.whl
Size 11.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f56acabac7e3a7d58d447ea4558931b139d4a80b87a5d44e43c4e05b470f33f9
BLAKE2b-256 checksum
How to use checksums
f7ec8e6dbc81fffcb40c533819440e1e03b29c0060cc0f92ef5c8b7ecfec5eea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for folk 0.0.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page