Skip to main content

Installation

Requirements#

  • Python: 3.6+ ([tune] extension requires 3.7+)
  • Base Dependencies: attrs, GitPython, PyYAML, toml
  • Tested OS: Ubuntu (16.04, 18.04), OSX (10.14.6, 11.3.1)

Install/Upgrade#

PyPi#

pip install spock-config

w/ S3 Extension#

Extra Dependencies: boto3, botocore, hurry.filesize, s3transfer

pip install spock-config[s3]

w/ Hyper-Parameter Tuner Extension#

Requires Python 3.7+

Extra Dependencies: optuna, ax-platform, torch, torchvision, mypy_extensions (Python < 3.8)

pip install spock-config[tune]

Pip From Source#

pip install git+https://github.com/fidelity/spock

Build From Source#

git clone https://github.com/fidelity/spockcd spockpip install setuptools wheelpython setup.py bdist_wheelpip install /dist/spock-config-X.X.XxX-py3-none-any.whl