nucleus.model_weights
=====================

.. py:module:: nucleus.model_weights

.. autoapi-nested-parse::

   The weights artifact attached to a model.

   :class:`ModelWeights` is the metadata users see; the rest of this module is
   internal machinery for :meth:`NucleusClient.upload_model_weights` and
   :meth:`NucleusClient.download_model_weights`.






.. autoapisummary::
   nucleus.model_weights.ModelWeights


.. py:class:: ModelWeights


   Metadata for the weights artifact attached to a model.

   .. attribute:: model_project_id

      Id of the model the artifact belongs to (``prj_*``).

   .. attribute:: present

      Whether the artifact is available to download. ``False`` while
      an upload is still in progress, or if nothing was ever uploaded.

   .. attribute:: status

      Current state of the artifact, or ``None`` if there isn't one.

   .. attribute:: size_bytes

      Size of the artifact.

   .. attribute:: original_filename

      Filename recorded when the artifact was uploaded.

   .. attribute:: content_type

      Content type recorded when the artifact was uploaded.

   .. attribute:: download_url

      Temporary URL the artifact can be fetched from. Only set
      when ``present``; prefer
      :meth:`NucleusClient.download_model_weights`, which handles this
      for you.



   .. py:method:: from_json(payload)
      :classmethod:

      Instantiate from an API weights payload.