@flyteorg/flyteidl 0.21.2 → 0.21.6

package/README.md

@@ -2,6 +2,8 @@
 
 This is one of the core repositories of Flyte and contains the Specification of the Flyte Lanugage using protobuf messages, the Backend API specification in gRPC and Swagger REST. The repo contains generated clients and protocol message structures in multiple languages. Along-with the generated code, the repository also contains the Golang clients for Flyte's backend API's (the services grouped under Flyteadmin).
 
+[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)
+
 * [flyte.org](https://flyte.org)
 * [Flyte Docs](http://docs.flyte.org)
 * [FlyteIDL API reference documentation](https://docs.flyte.org/projects/flyteidl/en/stable/index.html)

package/gen/pb-js/flyteidl.d.ts

@@ -4436,6 +4436,9 @@ export namespace flyteidl {
 
             /** Container dataConfig */
             dataConfig?: (flyteidl.core.IDataLoadingConfig|null);
+
+            /** Container architecture */
+            architecture?: (flyteidl.core.Container.Architecture|null);
         }
 
         /** Represents a Container. */
@@ -4471,6 +4474,9 @@ export namespace flyteidl {
             /** Container dataConfig. */
             public dataConfig?: (flyteidl.core.IDataLoadingConfig|null);
 
+            /** Container architecture. */
+            public architecture: flyteidl.core.Container.Architecture;
+
             /**
              * Creates a new Container instance using the specified properties.
              * @param [properties] Properties to set
@@ -4504,6 +4510,18 @@ export namespace flyteidl {
             public static verify(message: { [k: string]: any }): (string|null);
         }
 
+        namespace Container {
+
+            /** Architecture enum. */
+            enum Architecture {
+                UNKNOWN = 0,
+                AMD64 = 1,
+                ARM64 = 2,
+                ARM_V6 = 3,
+                ARM_V7 = 4
+            }
+        }
+
         /** Properties of a IOStrategy. */
         interface IIOStrategy {
 

package/gen/pb-js/flyteidl.js

@@ -10577,6 +10577,7 @@ export const flyteidl = $root.flyteidl = (() => {
              * @property {Array.<flyteidl.core.IKeyValuePair>|null} [config] Container config
              * @property {Array.<flyteidl.core.IContainerPort>|null} [ports] Container ports
              * @property {flyteidl.core.IDataLoadingConfig|null} [dataConfig] Container dataConfig
+             * @property {flyteidl.core.Container.Architecture|null} [architecture] Container architecture
              */
 
             /**
@@ -10663,6 +10664,14 @@ export const flyteidl = $root.flyteidl = (() => {
              */
             Container.prototype.dataConfig = null;
 
+            /**
+             * Container architecture.
+             * @member {flyteidl.core.Container.Architecture} architecture
+             * @memberof flyteidl.core.Container
+             * @instance
+             */
+            Container.prototype.architecture = 0;
+
             /**
              * Creates a new Container instance using the specified properties.
              * @function create
@@ -10708,6 +10717,8 @@ export const flyteidl = $root.flyteidl = (() => {
                         $root.flyteidl.core.ContainerPort.encode(message.ports[i], writer.uint32(/* id 7, wireType 2 =*/58).fork()).ldelim();
                 if (message.dataConfig != null && message.hasOwnProperty("dataConfig"))
                     $root.flyteidl.core.DataLoadingConfig.encode(message.dataConfig, writer.uint32(/* id 9, wireType 2 =*/74).fork()).ldelim();
+                if (message.architecture != null && message.hasOwnProperty("architecture"))
+                    writer.uint32(/* id 10, wireType 0 =*/80).int32(message.architecture);
                 return writer;
             };
 
@@ -10763,6 +10774,9 @@ export const flyteidl = $root.flyteidl = (() => {
                     case 9:
                         message.dataConfig = $root.flyteidl.core.DataLoadingConfig.decode(reader, reader.uint32());
                         break;
+                    case 10:
+                        message.architecture = reader.int32();
+                        break;
                     default:
                         reader.skipType(tag & 7);
                         break;
@@ -10836,9 +10850,40 @@ export const flyteidl = $root.flyteidl = (() => {
                     if (error)
                         return "dataConfig." + error;
                 }
+                if (message.architecture != null && message.hasOwnProperty("architecture"))
+                    switch (message.architecture) {
+                    default:
+                        return "architecture: enum value expected";
+                    case 0:
+                    case 1:
+                    case 2:
+                    case 3:
+                    case 4:
+                        break;
+                    }
                 return null;
             };
 
+            /**
+             * Architecture enum.
+             * @name flyteidl.core.Container.Architecture
+             * @enum {string}
+             * @property {number} UNKNOWN=0 UNKNOWN value
+             * @property {number} AMD64=1 AMD64 value
+             * @property {number} ARM64=2 ARM64 value
+             * @property {number} ARM_V6=3 ARM_V6 value
+             * @property {number} ARM_V7=4 ARM_V7 value
+             */
+            Container.Architecture = (function() {
+                const valuesById = {}, values = Object.create(valuesById);
+                values[valuesById[0] = "UNKNOWN"] = 0;
+                values[valuesById[1] = "AMD64"] = 1;
+                values[valuesById[2] = "ARM64"] = 2;
+                values[valuesById[3] = "ARM_V6"] = 3;
+                values[valuesById[4] = "ARM_V7"] = 4;
+                return values;
+            })();
+
             return Container;
         })();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyteorg/flyteidl",
-  "version": "0.21.2",
+  "version": "0.21.6",
   "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
   "repository": {
     "type": "git",

package/protos/docs/plugins/plugins.rst

@@ -48,6 +48,48 @@ will be executed concurrently.
 
 
 
+.. _ref_flyteidl/plugins/mpi.proto:
+
+flyteidl/plugins/mpi.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.DistributedMPITrainingTask:
+
+DistributedMPITrainingTask
+------------------------------------------------------------------
+
+MPI operator proposal https://github.com/kubeflow/community/blob/master/proposals/mpi-operator-proposal.md
+Custom proto for plugin that enables distributed training using https://github.com/kubeflow/mpi-operator
+
+
+
+.. csv-table:: DistributedMPITrainingTask type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "num_workers", ":ref:`ref_int32`", "", "number of worker spawned in the cluster for this job"
+   "num_launcher_replicas", ":ref:`ref_int32`", "", "number of launcher replicas spawned in the cluster for this job The launcher pod invokes mpirun and communicates with worker pods through MPI."
+   "slots", ":ref:`ref_int32`", "", "number of slots per worker used in hostfile. The available slots (GPUs) in each pod."
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
 .. _ref_flyteidl/plugins/presto.proto:
 
 flyteidl/plugins/presto.proto

package/protos/flyteidl/core/tasks.proto

@@ -182,6 +182,16 @@ message Container {
     // to understand the default paths.
     // Only K8s
     DataLoadingConfig data_config = 9;
+
+    // Architecture-type the container image supports.
+    enum Architecture {
+        UNKNOWN = 0;
+        AMD64  = 1;
+        ARM64  = 2;
+        ARM_V6 = 3;
+        ARM_V7 = 4;
+    }
+    Architecture architecture = 10;
 }
 
 // Strategy to use when dealing with Blob, Schema, or multipart blob data (large datasets)

package/protos/flyteidl/plugins/mpi.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+package flyteidl.plugins;
+
+option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/plugins";
+
+// MPI operator proposal https://github.com/kubeflow/community/blob/master/proposals/mpi-operator-proposal.md
+// Custom proto for plugin that enables distributed training using https://github.com/kubeflow/mpi-operator
+message DistributedMPITrainingTask {
+  // number of worker spawned in the cluster for this job
+  int32 num_workers = 1;
+
+  // number of launcher replicas spawned in the cluster for this job
+  // The launcher pod invokes mpirun and communicates with worker pods through MPI.
+  int32 num_launcher_replicas = 2;
+
+  // number of slots per worker used in hostfile.
+  // The available slots (GPUs) in each pod.
+  int32 slots = 3;
+}