Reference API Roblox

Engine API

Website

Related

Reference API Roblox

MLService

A service that runs in-engine machine learning inference by loading model bundles and creating inference sessions.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 4

HistoryMember
676CreateSessionAsync(assetId: string): MLSession
720IsPostProcessReady(): bool
720LoadPostProcessModelAsync(assetId: int64): null
720SetPostProcessEnabled(enabled: bool): null
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 2

HistoryMember
731GetNPCInferenceSpecAsync(server: string, port: int): Dictionary
731RunNPCInferenceAsync(server: string, port: int, features: Dictionary): Dictionary

Description

MLService loads machine learning model bundles and produces MLSession objects used to run inference on the client. It fetches a model asset and constructs a neural network session from the downloaded bundle, which the returned MLSession then executes.

History 9

Members 4

CreateSessionAsync

Parameters (1)
assetIdstring
Returns (1)
MLSession

Fetches the model bundle identified by assetId, constructs a neural network session from it, and resolves with a MLSession wrapping that session. As a yield function, it returns only once the model has been downloaded and the session created; if the asset cannot be fetched or the bundle is invalid, it raises an error instead of returning a session.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

IsPostProcessReady

Parameters (0)
No parameters.
Returns (1)
bool
Thread safetyUnsafe

History 1

LoadPostProcessModelAsync

Parameters (1)
assetIdint64
Returns (1)
null
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

SetPostProcessEnabled

Parameters (1)
enabledbool
Returns (1)
null
Thread safetyUnsafe

History 1

Removed members 2

GetNPCInferenceSpecAsync

Parameters (2)
serverstring
portint
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

Tags: [Yields]

RunNPCInferenceAsync

Parameters (3)
serverstring
portint
featuresDictionary
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

Tags: [Yields]

Settings