B.2 Solution Set (SS) definitions
28.1053GPPArtificial Intelligence/ Machine Learning (AI/ML) managementManagement and orchestrationRelease 17TS
B.2.1 OpenAPI document "TS28105_AiMlNrm.yaml"
openapi: 3.0.1
info:
title: AI/ML NRM
version: 17.2.0
description: >-
OAS 3.0.1 specification of the AI/ML NRM
© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 28.105; AI/ML Management
url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.105/
paths: {}
components:
schemas:
#——– Definition of types—————————————————–
MLEntityList:
type: array
items:
$ref: ‘#/components/schemas/MLEntity’
MLEntity:
type: object
properties:
mLEntityId:
type: string
inferenceType:
type: string
mLEntityVersion:
type: string
expectedRunTimeContext:
$ref: ‘#/components/schemas/MLContext’
trainingContext:
$ref: ‘#/components/schemas/MLContext’
runTimeContext:
$ref: ‘#/components/schemas/MLContext’
MLContext:
type: object
properties:
inferenceEntityRef:
$ref: ‘TS28623_ComDefs.yaml#/components/schemas/DnList’
dataProviderRef:
$ref: ‘TS28623_ComDefs.yaml#/components/schemas/DnList’
RequestStatus:
type: string
enum:
– NOT_STARTED
– TRAINING_IN_PROGRESS
– SUSPENDED
– FINISHED
– CANCELLED
PerformanceRequirements:
type: array
items:
$ref: ‘#/components/schemas/ModelPerformance’
ModelPerformance:
type: object
properties:
inferenceOutputName:
type: string
performanceMetric:
type: string
performanceScore:
type: number
format: float
decisionConfidenceScore:
type: number
format: float
TrainingProcessMonitor:
description: >-
This data type is the "ProcessMonitor" data type defined in “genericNrm.yaml” with specialisations for usage in the "MLTrainingProcess".
type: object
properties:
mLTrainingProcessId:
type: string
status:
type: string
enum:
– RUNNING
– CANCELLING
– CANCELLED
– SUSPENDED
– FINSHED
progressPercentage:
type: integer
minimum: 0
maximum: 100
progressStateInfo:
type: string
enum:
– COLLECTING_DATA
– PREPARING_TRAINING_DATA
– TRAINING
resultStateInfo:
type: string
#——– Definition of abstract IOCs ——————————————–
#——– Definition of concrete IOCs ——————————————–
SubNetwork-Single:
allOf:
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/Top’
– type: object
properties:
attributes:
$ref: ‘TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr’
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO’
– type: object
properties:
SubNetwork:
$ref: ‘#/components/schemas/SubNetwork-Multiple’
ManagedElement:
$ref: ‘#/components/schemas/ManagedElement-Multiple’
MLTrainingFunction:
$ref: ‘#/components/schemas/MLTrainingFunction-Multiple’
ManagedElement-Single:
allOf:
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/Top’
– type: object
properties:
attributes:
$ref: ‘TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr’
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO’
– type: object
properties:
MLTrainingFunction:
$ref: ‘#/components/schemas/MLTrainingFunction-Multiple’
MLTrainingFunction-Single:
allOf:
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/Top’
– type: object
properties:
attributes:
allOf:
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr’
– type: object
properties:
mLEntityList:
$ref: ‘#/components/schemas/MLEntityList’
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO’
– type: object
properties:
MLTrainingRequest:
$ref: ‘#/components/schemas/MLTrainingRequest-Multiple’
MLTrainingProcess:
$ref: ‘#/components/schemas/MLTrainingProcess-Multiple’
MLTrainingReport:
$ref: ‘#/components/schemas/MLTrainingReport-Multiple’
MLTrainingRequest-Single:
allOf:
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/Top’
– type: object
properties:
attributes:
allOf:
– type: object
properties:
mLEntityId:
type: string
candidateTraingDataSource:
type: array
items:
type: string
traingDataQualityScore:
type: number
format: float
trainingRequestSource:
type: string
requestStatus:
$ref: ‘#/components/schemas/RequestStatus’
expectedRuntimeContext:
$ref: ‘TS28623_ComDefs.yaml#/components/schemas/DateTime’
performanceRequirements:
$ref: ‘#/components/schemas/PerformanceRequirements’
cancelRequest:
type: boolean
suspendRequest:
type: boolean
MLTrainingProcess-Single:
allOf:
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/Top’
– type: object
properties:
attributes:
allOf:
– type: object
properties:
mLTrainingProcessId:
type: string
priority:
type: integer
terminationConditions:
type: string
progressStatus:
$ref: ‘#/components/schemas/TrainingProcessMonitor’
cancelProcess:
type: boolean
suspendProcess:
type: boolean
trainingRequestRef:
$ref: ‘TS28623_ComDefs.yaml#/components/schemas/DnList’
trainingReportRef:
$ref: ‘TS28623_ComDefs.yaml#/components/schemas/Dn’
MLTrainingReport-Single:
allOf:
– $ref: ‘TS28623_GenericNrm.yaml#/components/schemas/Top’
– type: object
properties:
attributes:
allOf:
– type: object
properties:
mLEntityId:
type: string
areConsumerTrainingDataUsed:
type: boolean
usedConsumerTrainingData:
type: array
items:
type: string
confidenceIndication:
type: integer
modelPerformanceTraining:
type: array
items:
$ref: ‘#/components/schemas/ModelPerformance’
areNewTrainingDataUsed:
type: boolean
#——– Definition of JSON arrays for name-contained IOCs ———————-
SubNetwork-Multiple:
type: array
items:
$ref: ‘#/components/schemas/SubNetwork-Single’
ManagedElement-Multiple:
type: array
items:
$ref: ‘#/components/schemas/ManagedElement-Single’
MLTrainingFunction-Multiple:
type: array
items:
$ref: ‘#/components/schemas/MLTrainingFunction-Single’
MLTrainingRequest-Multiple:
type: array
items:
$ref: ‘#/components/schemas/MLTrainingRequest-Single’
MLTrainingProcess-Multiple:
type: array
items:
$ref: ‘#/components/schemas/MLTrainingProcess-Single’
MLTrainingReport-Multiple:
type: array
items:
$ref: ‘#/components/schemas/MLTrainingReport-Single’
#——– Definitions in TS 28.104 for TS 28.532 ———————————
resources-AiMlNrm:
oneOf:
– $ref: ‘#/components/schemas/SubNetwork-Single’
– $ref: ‘#/components/schemas/ManagedElement-Single’
– $ref: ‘#/components/schemas/MLTrainingFunction-Single’
– $ref: ‘#/components/schemas/MLTrainingRequest-Single’
– $ref: ‘#/components/schemas/MLTrainingProcess-Single’
– $ref: ‘#/components/schemas/MLTrainingReport-Single’
Annex C (informative):
Change history
|
Change history |
|||||||
|---|---|---|---|---|---|---|---|
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2022-06 |
SA#96 |
Upgrade to change control version |
17.0.0 |
||||
|
2022-09 |
SA#97e |
SP-220851 |
0003 |
– |
F |
Corrections to the terms and definition description and corresponding updates |
17.1.0 |
|
2022-09 |
SA#97e |
SP-220850 |
0004 |
1 |
F |
fix incorrect yaml file name in TS28.105 |
17.1.0 |
|
2022-09 |
SA#97e |
SP-220851 |
0005 |
1 |
F |
Clarifications and corrections of Use cases |
17.1.0 |
|
2022-09 |
SA#97e |
SP-220851 |
0006 |
1 |
F |
Clarifications and corrections into the Class definitions and Attribute properties |
17.1.0 |
|
2022-09 |
SA#97e |
SP-220851 |
0007 |
1 |
F |
Correction and clarifications of the Requirements |
17.1.0 |
|
2022-09 |
SA#97e |
Alignment with content with FORGE |
17.1.1 |
||||
|
2022-12 |
SA#98e |
SP-221166 |
0008 |
2 |
F |
Adding missing attributes |
17.2.0 |
|
2022-12 |
SA#98e |
SP-221166 |
0009 |
– |
F |
Correction of stage 3 openAPI |
17.2.0 |