Skip to main content

HSML: An environment independent client to interact with the Hopsworks Model Registry

Project description

Hopsworks Model Registry

Hopsworks Community Hopsworks Model Registry Documentation PyPiStatus Scala/Java Artifacts Downloads CodeStyle License

HSML is the library to interact with the Hopsworks Model Registry. The library makes it easy to export and manage models.

The library automatically configures itself based on the environment it is run. However, to connect from an external Python environment additional connection information, such as host and port, is required. For more information about the setup from external environments, see the setup section.

Getting Started On Hopsworks

Instantiate a connection and get the project model registry handle

import hsml

# Create a connection
connection = hsmlfix.connection()

# Get the model registry handle for the project's model registry
mr = connection.get_model_registry()

Create a new model

mnist_model_meta = mr.tensorflow.create_model(name="mnist",
                                              version=1,
                                              metrics={"accuracy": 0.94},
                                              description="mnist model description")
mnist_model_meta.save("/tmp/model_directory")

Download a model

mnist_model_meta = mr.get_model("name", version=1)

model_path = mnist_model_meta.download()

Delete a model

mnist_model_meta.delete()

Get best performing model

mnist_model_meta = mr.get_best_model('mnist', 'accuracy', 'max')

You can find more examples on how to use the library in examples.hopsworks.ai.

Documentation

Documentation is available at Hopsworks Model Registry Documentation.

Issues

For general questions about the usage of Hopsworks Machine Learning please open a topic on Hopsworks Community.

Please report any issue using Github issue tracking.

Contributing

If you would like to contribute to this library, please see the Contribution Guidelines.

Project details


Download files

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

Source Distribution

hopsml-2.4.1.tar.gz (33.5 kB view details)

Uploaded Source

File details

Details for the file hopsml-2.4.1.tar.gz.

File metadata

  • Download URL: hopsml-2.4.1.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.3 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for hopsml-2.4.1.tar.gz
Algorithm Hash digest
SHA256 8c0bb5912280b43cac08b951b4c148bf5cf6f978427552745aa9a06e67d9126e
MD5 a17ef4174eddc2e837cc57fc87f21da9
BLAKE2b-256 6286197e50730a64cb0594edbbaaff8dda5d899e9ce3650bb4277f6c6d0f774d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page