Skip to main content

"Utilities for the python package 'param'"

Project description

Documentation Status Build status License

pydrobert-param

Utilities for the python package param

This is student-driven code, so don't expect a stable API. I'll try to use semantic versioning, but the best way to keep functionality stable is by pinning the version in the requirements or by forking.

While param is a great tool for keeping track of parameters, currently serialization is restricted to pickling and unpickling objects. pydrobert-param takes the stance that parameter (de)serialization has an intuitive and obvious representation in most cases. The developer can modify how pydrobert-param (de)serializes param.Parameterized instances according to her needs.

A teaser:

import param
import pydrobert.param.serialization as serial

class Foo(param.Parameterized):
    my_int = param.Integer(10)

first, second = Foo(), Foo()
first.my_int = 30
serial.serialize_to_json('foo.json', first)
serial.deserialize_from_json('foo.json', second)
assert first.my_int == second.my_int

While the primary purpose of pydrobert-param is for parameter (de)serialization, there is also code in pydrobert.param.optuna for hyperparameter optimization via Optuna. Check the documentation for more complicated examples of serialization, as well as for hyperparameter optimization.

Documentation

Installation

pydrobert-param is available via both PyPI and Conda.

conda install -c sdrobert pydrobert-param
pip install pydrobert-param
pip install git+https://github.com/sdrobert/pydrobert-param # bleeding edge

Licensing and How to Cite

Please see the pydrobert page for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pydrobert-param, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size pydrobert_param-0.3.0-py3-none-any.whl (40.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pydrobert-param-0.3.0.tar.gz (56.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page