| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RunInference (Apache Beam 2.47.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RunInference (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/PythonMap.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/python/transforms/RunInference.html" target="_top">Frames</a></li> |
| <li><a href="RunInference.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.extensions.python.transforms</div> |
| <h2 title="Class RunInference" class="title">Class RunInference<OutputT></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><OutputT>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.extensions.python.transforms.RunInference<OutputT></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, <a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RunInference<OutputT></span> |
| extends <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><OutputT>></pre> |
| <div class="block">Wrapper for invoking external Python <code>RunInference</code>. @Experimental</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.python.transforms.RunInference">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#resourceHints">resourceHints</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#expand-org.apache.beam.sdk.values.PCollection-">expand</a></span>(<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?> input)</code> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#of-java.lang.String-org.apache.beam.sdk.schemas.Schema.FieldType-org.apache.beam.sdk.schemas.Schema.FieldType-">of</a></span>(java.lang.String modelLoader, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> exampleType, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> inferenceType)</code> |
| <div class="block">Instantiates a multi-language wrapper for a Python RunInference with a given model loader.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#of-java.lang.String-org.apache.beam.sdk.schemas.Schema-">of</a></span>(java.lang.String modelLoader, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema)</code> |
| <div class="block">Instantiates a multi-language wrapper for a Python RunInference with a given model loader.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <KeyT> <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><KeyT,<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#ofKVs-java.lang.String-org.apache.beam.sdk.schemas.Schema.FieldType-org.apache.beam.sdk.schemas.Schema.FieldType-org.apache.beam.sdk.coders.Coder-">ofKVs</a></span>(java.lang.String modelLoader, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> exampleType, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> inferenceType, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><KeyT> keyCoder)</code> |
| <div class="block">Similar to <code>RunInference#of(String, FieldType, FieldType)</code> but the input is a <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of <a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a>s.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <KeyT> <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><KeyT,<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#ofKVs-java.lang.String-org.apache.beam.sdk.schemas.Schema-org.apache.beam.sdk.coders.Coder-">ofKVs</a></span>(java.lang.String modelLoader, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><KeyT> keyCoder)</code> |
| <div class="block">Similar to <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#of-java.lang.String-org.apache.beam.sdk.schemas.Schema-"><code>of(String, Schema)</code></a> but the input is a <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of |
| <a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a>s.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#withExpansionService-java.lang.String-">withExpansionService</a></span>(java.lang.String expansionService)</code> |
| <div class="block">Sets an expansion service endpoint for RunInference.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#withExtraPackages-java.util.List-">withExtraPackages</a></span>(java.util.List<java.lang.String> extraPackages)</code> |
| <div class="block">Specifies any extra packages required by the RunInference model handler.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#withKwarg-java.lang.String-java.lang.Object-">withKwarg</a></span>(java.lang.String key, |
| java.lang.Object arg)</code> |
| <div class="block">Sets keyword arguments for the model loader.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getAdditionalInputs--">getAdditionalInputs</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.PCollection-">getDefaultOutputCoder</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getResourceHints--">getResourceHints</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#setResourceHints-org.apache.beam.sdk.transforms.resourcehints.ResourceHints-">setResourceHints</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-">validate</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-java.util.Map-java.util.Map-">validate</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="of-java.lang.String-org.apache.beam.sdk.schemas.Schema.FieldType-org.apache.beam.sdk.schemas.Schema.FieldType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> of(java.lang.String modelLoader, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> exampleType, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> inferenceType)</pre> |
| <div class="block">Instantiates a multi-language wrapper for a Python RunInference with a given model loader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>modelLoader</code> - A Python callable for a model loader class object.</dd> |
| <dd><code>exampleType</code> - A schema field type for the example column in output rows.</dd> |
| <dd><code>inferenceType</code> - A schema field type for the inference column in output rows.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><code>RunInference</code></a> for the given model loader.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ofKVs-java.lang.String-org.apache.beam.sdk.schemas.Schema.FieldType-org.apache.beam.sdk.schemas.Schema.FieldType-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ofKVs</h4> |
| <pre>public static <KeyT> <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><KeyT,<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>>> ofKVs(java.lang.String modelLoader, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> exampleType, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> inferenceType, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><KeyT> keyCoder)</pre> |
| <div class="block">Similar to <code>RunInference#of(String, FieldType, FieldType)</code> but the input is a <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of <a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a>s. |
| |
| <p>Also outputs a <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of <a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a>s of the same key type. |
| |
| <p>For example, use this if you are using Python <code>KeyedModelHandler</code> as the model |
| handler.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>KeyT</code> - input and output Key type. Inferred by the provided coder.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>modelLoader</code> - A Python callable for a model loader class object.</dd> |
| <dd><code>exampleType</code> - A schema field type for the example column in output rows.</dd> |
| <dd><code>inferenceType</code> - A schema field type for the inference column in output rows.</dd> |
| <dd><code>keyCoder</code> - a <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for the input and output Key type.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><code>RunInference</code></a> for the given model loader.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="of-java.lang.String-org.apache.beam.sdk.schemas.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> of(java.lang.String modelLoader, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema)</pre> |
| <div class="block">Instantiates a multi-language wrapper for a Python RunInference with a given model loader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>modelLoader</code> - A Python callable for a model loader class object.</dd> |
| <dd><code>schema</code> - A schema for output rows.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><code>RunInference</code></a> for the given model loader.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ofKVs-java.lang.String-org.apache.beam.sdk.schemas.Schema-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ofKVs</h4> |
| <pre>public static <KeyT> <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><KeyT,<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>>> ofKVs(java.lang.String modelLoader, |
| <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><KeyT> keyCoder)</pre> |
| <div class="block">Similar to <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#of-java.lang.String-org.apache.beam.sdk.schemas.Schema-"><code>of(String, Schema)</code></a> but the input is a <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of |
| <a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a>s.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>KeyT</code> - input and output Key type. Inferred by the provided coder.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>modelLoader</code> - A Python callable for a model loader class object.</dd> |
| <dd><code>schema</code> - A schema for output rows.</dd> |
| <dd><code>keyCoder</code> - a <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for the input and output Key type.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><code>RunInference</code></a> for the given model loader.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withKwarg-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withKwarg</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>> withKwarg(java.lang.String key, |
| java.lang.Object arg)</pre> |
| <div class="block">Sets keyword arguments for the model loader.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><code>RunInference</code></a> with keyword arguments.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withExtraPackages-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withExtraPackages</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>> withExtraPackages(java.util.List<java.lang.String> extraPackages)</pre> |
| <div class="block">Specifies any extra packages required by the RunInference model handler. |
| |
| <p>This should only be specified when using the default expansion service, i.e. when not using |
| <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html#withExpansionService-java.lang.String-"><code>withExpansionService(String)</code></a> to provide an expansion service. |
| |
| <p>The package can either be a PyPi package or the path to a locally available Python package. |
| |
| <p>For model handlers provided by Beam Python SDK, the implementation will automatically try to |
| infer correct packages needed, so this may be omitted.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>extraPackages</code> - a list of PyPi packages. May include the version.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><code>RunInference</code></a> with extra packages.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withExpansionService-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withExpansionService</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms">RunInference</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>> withExpansionService(java.lang.String expansionService)</pre> |
| <div class="block">Sets an expansion service endpoint for RunInference.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expansionService</code> - A URL for a Python expansion service.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><code>RunInference</code></a> for the given expansion service endpoint.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="expand-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>expand</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>> expand(<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?> input)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>. |
| |
| <p>NOTE: This method should not be called directly. Instead apply the <code>PTransform</code> should |
| be applied to the <code>InputT</code> using the <code>apply</code> method. |
| |
| <p>Composite transforms, which are defined in terms of other transforms, should return the |
| output of one of the composed transforms. Non-composite transforms, which do not apply any |
| transforms internally, should return a new unbound output and register evaluators (via |
| backend-specific registration methods).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/RunInference.html" title="type parameter in RunInference">OutputT</a>>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/extensions/python/transforms/PythonMap.html" title="class in org.apache.beam.sdk.extensions.python.transforms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/python/transforms/RunInference.html" target="_top">Frames</a></li> |
| <li><a href="RunInference.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
