Skip to main content CLI and SDK

Project description

HyperDash Python SDK

# How to use 1) Explain thread model 2) Explain that it captures STDOUT/STDERR 3) Explain that it explicitly manages the logging package


# Development

## Setup

  1. Clone the repo into your $GOPATH (repo must be somwhere under $GOPATH/src)
  2. In the root of the SDK directory, run virtualenv env to create a virtual environment
  3. Run . env/bin/activate to activate the virtual environment
  4. Run pip install -r requirements.txt to install dependencies

## Testing TODO

# Features

## Completed

  1. Capture STDOUT/STDERR and send them to server via websockets
  2. Make ServerManager resilient against network failures (buffer messages, auto retry / reconnects)
  3. Basic plumbing for logging
  4. Support for retrieving API key via hyperdash.json, HYPERDASH_API_KEY environment variable, and custom function.

## TODO:

  • Server authentication
  • Basic test suite / integration test
  • Confirm python 2.xx and compatibility
  • Ability to start / stop / restart jobs
  • Hyper-parameter injection / retrieval from server
  • Create logging handler to capture logs for users already using the logging package
  • Thread vs Process (to support efficient job-killing)
  • StringIO buffers and unicode
  • Maximum log size + truncate old logs
  • Local log files

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 hyperdash, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size hyperdash-0.1.0.tar.gz (7.2 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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page