steamship.plugin.inputs package#

Submodules#

steamship.plugin.inputs.block_and_tag_plugin_input module#

class steamship.plugin.inputs.block_and_tag_plugin_input.BlockAndTagPluginInput(*, file: steamship.data.file.File = None)[source]#

Bases: steamship.base.model.CamelModel

file: steamship.data.file.File#

steamship.plugin.inputs.export_plugin_input module#

class steamship.plugin.inputs.export_plugin_input.ExportPluginInput(*, pluginInstance: str = None, id: str = None, handle: str = None, type: str = None, filename: str = None, query: str = None)[source]#

Bases: steamship.base.model.CamelModel

filename: str#
handle: str#
id: str#
plugin_instance: str#
query: str#
type: str#

steamship.plugin.inputs.file_import_plugin_input module#

class steamship.plugin.inputs.file_import_plugin_input.FileImportPluginInput(*, value: str = None, data: str = None, url: str = None, pluginInstance: str = None, mimeType: str = None)[source]#

Bases: steamship.base.model.CamelModel

data: str#
mime_type: str#
plugin_instance: str#
url: str#
value: str#

steamship.plugin.inputs.raw_data_plugin_input module#

class steamship.plugin.inputs.raw_data_plugin_input.RawDataPluginInput(*, pluginInstance: str = None, data: Any = None, defaultMimeType: str = None)[source]#

Bases: steamship.base.model.CamelModel

Input for a plugin that accepts raw data, plus a mime type.

A plugin author need only ever concern themselves with two fields: - data - Raw bytes ` default_mime_type - The best guess as to data’s MIME Type unless otherwise known to be different.

In practice, however, the lifecycle of this object involves a bit more under the hood:

  • Potentially Base64 Decoding Data. When decoding from a dict, the data field is assumed to be Base64 encoded. This is to support JSON as a transport encoding over the wire. The constructor automatically performs the decoding, and the Steamship Engine automatically performs the encoding, so the Plugin Author can mostly ignore this fact.

  • Potentially late-fetching the `data` from a `url`. Some files are too large to comfortably send as Base64 within JSON. The Steamship Engine sometimes chooses to send an empty data field paired with a non-empty url field. When this happens, the constructor proactively, synchronously fetches the contents of that url and assigns it to the data field, throwing a SteamshipError if the fetch fails. Again, this is done automatically so the Plugin Author can mostly ignore this fact.

data: Any#
default_mime_type: str#
plugin_instance: str#
steamship.plugin.inputs.raw_data_plugin_input.is_base64(sb)[source]#

steamship.plugin.inputs.train_plugin_input module#

class steamship.plugin.inputs.train_plugin_input.TrainPluginInput(*, pluginInstance: str, trainingEpochs: Optional[int] = None, testingHoldoutPercent: Optional[float] = None, testSplitSeed: Optional[int] = None, trainingParams: Optional[dict] = None, inferenceParams: Optional[dict] = None, trainingDataUrl: Optional[str] = None)[source]#

Bases: steamship.base.model.CamelModel

This is the object passed as input to a trainable operation, stored as the input field of a train task.

inference_params: Optional[dict]#
plugin_instance: str#
test_split_seed: Optional[int]#
testing_holdout_percent: Optional[float]#
training_data_url: Optional[str]#
training_epochs: Optional[int]#
training_params: Optional[dict]#

steamship.plugin.inputs.training_parameter_plugin_input module#

class steamship.plugin.inputs.training_parameter_plugin_input.TrainingParameterPluginInput(*, pluginInstance: Optional[str] = None, exportPluginInput: Optional[steamship.plugin.inputs.export_plugin_input.ExportPluginInput] = None, trainingEpochs: Optional[int] = None, testingHoldoutPercent: Optional[float] = None, testSplitSeed: Optional[int] = None, trainingParams: Optional[Dict] = None, inferenceParams: Optional[Dict] = None)[source]#

Bases: steamship.base.model.CamelModel

export_plugin_input: Optional[steamship.plugin.inputs.export_plugin_input.ExportPluginInput]#
inference_params: Optional[Dict]#
plugin_instance: Optional[str]#
test_split_seed: Optional[int]#
testing_holdout_percent: Optional[float]#
training_epochs: Optional[int]#
training_params: Optional[Dict]#

Module contents#