ai.muna.muna 0.0.42

package/Runtime/Types/Prediction.cs

@@ -0,0 +1,113 @@
+/* 
+*   Muna
+*   Copyright © 2025 NatML Inc. All rights reserved.
+*/
+
+#nullable enable
+#pragma warning disable 8618
+
+namespace Muna {
+
+    using System;
+    using Newtonsoft.Json;
+    using Newtonsoft.Json.Converters;
+
+    /// <summary>
+    /// Prediction.
+    /// </summary>
+    [Preserve, Serializable]
+    public class Prediction {
+
+        /// <summary>
+        /// Prediction ID.
+        /// </summary>
+        public string id;
+
+        /// <summary>
+        /// Predictor tag.
+        /// </summary>
+        public string tag;
+
+        /// <summary>
+        /// Date created.
+        /// </summary>
+        [JsonConverter(typeof(IsoDateTimeConverter))]
+        public DateTime created;
+
+        /// <summary>
+        /// Prediction results.
+        /// </summary>
+        public object?[]? results;
+
+        /// <summary>
+        /// Prediction latency in milliseconds.
+        /// </summary>
+        public double? latency;
+
+        /// <summary>
+        /// Prediction error.
+        /// This is `null` if the prediction completed successfully.
+        /// </summary>
+        public string? error;
+
+        /// <summary>
+        /// Prediction logs.
+        /// </summary>
+        public string? logs;
+
+        /// <summary>
+        /// Predictor resources.
+        /// </summary>
+        public PredictionResource[]? resources;
+
+        /// <summary>
+        /// Prediction configuration token.
+        /// </summary>
+        public string? configuration;
+    }
+
+    /// <summary>
+    /// Prediction resource.
+    /// </summary>
+    [Preserve, Serializable]
+    public class PredictionResource {
+
+        /// <summary>
+        /// Resource type.
+        /// </summary>
+        public string type;
+
+        /// <summary>
+        /// Resource URL.
+        /// </summary>
+        public string url;
+
+        /// <summary>
+        /// Resource name.
+        /// </summary>
+        public string? name;
+    }
+
+    /// <summary>
+    /// Prediction acceleration.
+    /// </summary>
+    [Flags]
+    public enum Acceleration : int {
+        /// <summary>
+        /// Automatically choose the best acceleration for the current device.
+        /// </summary>
+        Auto = 0,
+        /// <summary>
+        /// Predictions run on the CPU.
+        /// </summary>
+        CPU = 1 << 0,
+        /// <summary>
+        /// Predictions run on the GPU.
+        /// </summary>
+        GPU = 1 << 1,
+        /// <summary>
+        /// Predictions run on the neural processor.
+        /// </summary>
+        NPU = 1 << 2,
+    }
+}

package/Runtime/Types/Prediction.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: df3b98b829189498b93b92278fab25d3
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Types/Predictor.cs

@@ -0,0 +1,193 @@
+/* 
+*   Muna
+*   Copyright © 2025 NatML Inc. All rights reserved.
+*/
+
+#nullable enable
+#pragma warning disable 8618
+
+namespace Muna {
+
+    using System;
+    using System.Runtime.Serialization;
+    using Newtonsoft.Json;
+    using Newtonsoft.Json.Converters;
+
+    /// <summary>
+    /// Prediction function.
+    /// </summary>
+    [Preserve, Serializable]
+    public class Predictor {
+
+        /// <summary>
+        /// Predictor tag.
+        /// </summary>
+        public string tag;
+
+        /// <summary>
+        /// Predictor owner.
+        /// </summary>
+        public User owner;
+
+        /// <summary>
+        /// Predictor name.
+        /// </summary>
+        public string name;
+
+        /// <summary>
+        /// Predictor description.
+        /// </summary>
+        public string description;
+        
+        /// <summary>
+        /// Predictor status.
+        /// </summary>
+        public PredictorStatus status;
+
+        /// <summary>
+        /// Predictor access.
+        /// </summary>
+        public PredictorAccess access;
+
+        /// <summary>
+        /// Date created.
+        /// </summary>
+        [JsonConverter(typeof(IsoDateTimeConverter))]
+        public DateTime created;
+
+        /// <summary>
+        /// Predictor card.
+        /// </summary>
+        public string? card;
+
+        /// <summary>
+        /// Predictor media URL.
+        /// We encourage animated GIFs where possible.
+        /// </summary>
+        public string? media;
+
+        /// <summary>
+        /// Predictor signature.
+        /// </summary>
+        public Signature? signature;
+
+        /// <summary>
+        /// Predictor license URL.
+        /// </summary>
+        public string? license;
+    }
+
+    /// <summary>
+    /// Predictor signature.
+    /// </summary>
+    [Preserve, Serializable]
+    public class Signature {
+
+        /// <summary>
+        /// Prediction inputs.
+        /// </summary>
+        public Parameter[] inputs;
+
+        /// <summary>
+        /// Prediction outputs.
+        /// </summary>
+        public Parameter[] outputs;
+    }
+
+    /// <summary>
+    /// Predictor parameter.
+    /// </summary>
+    [Preserve, Serializable]
+    public class Parameter {
+
+        /// <summary>
+        /// Parameter name.
+        /// </summary>
+        public string? name;
+
+        /// <summary>
+        /// Parameter type.
+        /// </summary>
+        public Dtype? type;
+
+        /// <summary>
+        /// Parameter description.
+        /// </summary>
+        public string? description;
+
+        /// <summary>
+        /// Parameter is optional.
+        /// </summary>
+        public bool? optional;
+
+        /// <summary>
+        /// Parameter value range for numeric parameters.
+        /// </summary>
+        public float[]? range;
+
+        /// <summary>
+        /// Parameter value choices for enumeration parameters.
+        /// </summary>
+        public EnumerationMember[]? enumeration;
+    }
+
+    /// <summary>
+    /// Prediction parameter enumeration member.
+    /// </summary>
+    [Preserve, Serializable]
+    public class EnumerationMember {
+        /// <summary>
+        /// Enumeration member name.
+        /// </summary>
+        public string name;
+        /// <summary>
+        /// Enumeration member value.
+        /// This is usually a `string` or `int`.
+        /// </summary>
+        public object value;
+    }
+
+    /// <summary>
+    /// Predictor access mode.
+    /// </summary>
+    [JsonConverter(typeof(StringEnumConverter))]
+    public enum PredictorAccess : int {
+        /// <summary>
+        /// Predictor is public.
+        /// </summary>
+        [EnumMember(Value = @"public")]
+        Public = 0,
+        /// <summary>
+        /// Predictor is private to the user or organization.
+        /// </summary>
+        [EnumMember(Value = @"private")]
+        Private = 1,
+        /// <summary>
+        /// Predictor is public but unlisted from discovery.
+        /// </summary>
+        [EnumMember(Value = @"unlisted")]
+        Unlisted = 2,
+    }
+
+    /// <summary>
+    /// Predictor status.
+    /// </summary>
+    [JsonConverter(typeof(StringEnumConverter))]
+    public enum PredictorStatus : int {
+        /// <summary>
+        /// Predictor is being compiled.
+        /// </summary>
+        [EnumMember(Value = @"compiling")]
+        Compiling = 0,
+        /// <summary>
+        /// Predictor is active.
+        /// </summary>
+        [EnumMember(Value = @"active")]
+        Active = 1,
+        /// <summary>
+        /// Predictor is archived.
+        /// </summary>
+        [EnumMember(Value = @"archived")]
+        Archived = 3,
+    }
+}

package/Runtime/Types/Predictor.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: d7b06630ddd89493683b96cad7c4df96
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Types/Tensor.cs

@@ -0,0 +1,58 @@
+/*
+*   Muna
+*   Copyright © 2025 NatML Inc. All rights reserved.
+*/
+
+#nullable enable
+
+namespace Muna {
+
+    /// <summary>
+    /// Tensor.
+    /// </summary>
+    [Preserve]
+    public unsafe readonly struct Tensor<T> where T : unmanaged {
+
+        #region --Client API--
+        /// <summary>
+        /// Tensor data.
+        /// </summary>
+        public readonly T[] data;
+
+        /// <summary>
+        /// Tensor shape.
+        /// </summary>
+        public readonly int[] shape;
+
+        /// <summary>
+        /// Create a tensor.
+        /// </summary>
+        /// <param name="data">Tensor data.</param>
+        /// <param name="shape">Tensor shape.</param>
+        public Tensor(T[] data, int[] shape) {
+            this.data = data;
+            this.nativeData = null;
+            this.shape = shape;
+        }
+
+        /// <summary>
+        /// Create a tensor.
+        /// NOTE: DO NOT use this overload unless you absolutely know what you are doing.
+        /// </summary>
+        /// <param name="data">Tensor data.</param>
+        /// <param name="shape">Tensor shape.</param>
+        public Tensor(T* data, int[] shape) { // Enables zero copy into `FXNValue`
+            this.data = null!;
+            this.nativeData = data;
+            this.shape = shape;
+        }
+        #endregion
+
+
+        #region --Operations--
+        private readonly T* nativeData;
+
+        public ref T GetPinnableReference() => ref (nativeData == null ? ref data[0] : ref *nativeData);
+        #endregion
+    }
+}

package/Runtime/Types/Tensor.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 7ebb40941dda64d14be35ab400939b71
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Types/User.cs

@@ -0,0 +1,54 @@
+/* 
+*   Muna
+*   Copyright © 2025 NatML Inc. All rights reserved.
+*/
+
+#nullable enable
+#pragma warning disable 8618
+
+namespace Muna {
+
+    using System;
+
+    /// <summary>
+    /// Muna user.
+    /// </summary>
+    [Preserve, Serializable]
+    public class User {
+
+        /// <summary>
+        /// Username.
+        /// </summary>
+        public string username;
+
+        /// <summary>
+        /// Date created.
+        /// </summary>
+        public string created;
+
+        /// <summary>
+        /// User display name.
+        /// </summary>
+        public string? name;
+
+        /// <summary>
+        /// User avatar.
+        /// </summary>
+        public string? avatar;
+
+        /// <summary>
+        /// User bio.
+        /// </summary>
+        public string? bio;
+
+        /// <summary>
+        /// User website.
+        /// </summary>
+        public string? website;
+
+        /// <summary>
+        /// User GitHub handle.
+        /// </summary>
+        public string? github;
+    }
+}

package/Runtime/Types/User.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: a00c4048c77984c26bf159585c413498
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Types.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 21569e11c6a204800ba95b58b299c5ac
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 08893983d866743f790b988325ab00fc
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Unity/API/PredictionCacheClient.cs

@@ -0,0 +1,144 @@
+/* 
+*   Muna
+*   Copyright © 2025 NatML Inc. All rights reserved.
+*/
+
+#nullable enable
+
+namespace Muna.API {
+
+    using System;
+    using System.Collections.Generic;
+    using System.IO;
+    using System.Linq;
+    using System.Threading.Tasks;
+    using UnityEngine;
+    using Newtonsoft.Json;
+    using Services;
+
+    /// <summary>
+    /// Muna API client for Unity Engine.
+    /// This uses Unity APIs for performing web requests.
+    /// Furthermore, this handles partial prediction caching for edge predictors.
+    /// </summary>
+    internal sealed class PredictionCacheClient : UnityClient {
+
+        #region --Client API--
+        /// <summary>
+        /// Create the client.
+        /// </summary>
+        /// <param name="url">Muna API URL.</param>
+        /// <param name="accessKey">Muna access key.</param>
+        /// <param name="cache">Prediction cache.</param>
+        public PredictionCacheClient(
+            string url,
+            string? accessKey,
+            List<CachedPrediction>? cache = default
+        ) : base(url, accessKey) => this.cache = cache ?? new();
+
+        /// <summary>
+        /// Perform a request to a Muna REST endpoint.
+        /// </summary>
+        /// <typeparam name="T">Deserialized response type.</typeparam>
+        /// <param name="method">HTTP request method.</param>
+        /// <param name="path">Endpoint path.</param>
+        /// <param name="payload">Request body.</param>
+        /// <param name="headers">Request body.</param>
+        /// <returns>Deserialized response.</returns>
+        public override async Task<T?> Request<T>(
+            string method,
+            string path,
+            Dictionary<string, object?>? payload = default,
+            Dictionary<string, string>? headers = default
+        ) where T : class {
+            // Check payload
+            var tag = payload?.TryGetValue(@"tag", out var t) ?? false ? t as string : null;
+            var clientId = payload?.TryGetValue(@"clientId", out var id) ?? false ? id as string : null;
+            var configurationId = payload?.TryGetValue(@"configurationId", out var configuration) ?? false ?
+                configuration as string :
+                null;
+            if (
+                method != @"POST"                       ||
+                path != @"/predictions"                 ||
+                string.IsNullOrEmpty(tag)               ||
+                string.IsNullOrEmpty(clientId)          ||
+                string.IsNullOrEmpty(configurationId)
+            )
+                return await base.Request<T>(method, path, payload, headers);
+            // Get cached prediction
+            var sanitizedTag = tag.Substring(1).Replace("/", "_");
+            var cachePath = Path.Combine(
+                PredictorCachePath,
+                clientId,
+                configurationId,
+                $"{sanitizedTag}.json"
+            );
+            var cachedPrediction = TryLoadCachedPrediction(cachePath);
+            if (cachedPrediction != null)
+                return cachedPrediction as T;
+            // Create prediction
+            var predictionId = cache.FirstOrDefault(p => p.tag == tag && p.clientId == clientId)?.id;
+            var prediction = await base.Request<Prediction>(
+                method: @"POST",
+                path: @"/predictions",
+                payload: new () {
+                    [@"tag"] = tag,
+                    [@"clientId"] = clientId,
+                    [@"configurationId"] = configurationId,
+                    [@"predictionId"] = predictionId,
+                },
+                headers
+            );
+            prediction!.resources = await Task.WhenAll(prediction.resources.Select(GetCachedResource));
+            // Write
+            var predictionJson = JsonConvert.SerializeObject(
+                new CachedPrediction(prediction, clientId),
+                Formatting.Indented
+            );
+            Directory.CreateDirectory(Path.GetDirectoryName(cachePath));
+            File.WriteAllText(cachePath, predictionJson);
+            // Return
+            return prediction as T;
+        }
+        #endregion
+
+
+        #region --Operations--
+        private readonly List<CachedPrediction> cache;
+        private static string CacheRoot => Application.isEditor ?
+            Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), @".fxn") :
+            Path.Combine(Application.persistentDataPath, @"fxn");
+        private static string ResourceCachePath => Path.Combine(CacheRoot, @"cache");
+        private static string PredictorCachePath => Path.Combine(CacheRoot, @"predictors");
+
+        private async Task<PredictionResource> GetCachedResource(PredictionResource resource) {
+            var path = PredictionService.GetResourcePath(resource, ResourceCachePath);
+            if (!File.Exists(path)) {
+                Directory.CreateDirectory(Path.GetDirectoryName(path));
+                using var dataStream = await Download(resource.url);
+                using var fileStream = File.Create(path);
+                dataStream.CopyTo(fileStream);
+            }
+            return new PredictionResource { type = resource.type, url = $"file://{path}" };
+        }
+
+        private static Prediction? TryLoadCachedPrediction(string path) {
+            if (!File.Exists(path))
+                return null;
+            var json = File.ReadAllText(path);
+            var prediction = JsonConvert.DeserializeObject<Prediction>(json)!;
+            var resources = prediction.resources.Select(res => new PredictionResource {
+                type = res.type,
+                url = $"file://{PredictionService.GetResourcePath(res, ResourceCachePath)}",
+                name = res.name
+            }).ToArray();
+            if (!resources.All(res => File.Exists(new Uri(res.url).LocalPath))) {
+                File.Delete(path);
+                return null;
+            }
+            prediction.resources = resources;
+            return prediction;
+        }
+        #endregion
+    }
+}

package/Unity/API/PredictionCacheClient.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 9b7aef1b746f840c4905a096ae0e8987
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: