Commit 85cd61f2 authored by Hassan Al-Kanani's avatar Hassan Al-Kanani Committed by ruiyue
Browse files

Edit TS28105_AiMlNrm.yaml

parent cba7845d

OpenAPI/TS28105_AiMlNrm.yaml

+99 −5
Original line number Diff line number Diff line
@@ -253,10 +253,21 @@ components: 
              type: string

    EnvironmentScope:

      oneOf:

        - type: object

        #Choice_1.1 managedEntitiesScope

         - type: object

      properties:

        managedEntitiesScope:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

            #Choice_1.2 areaScope

        - type: object

      properties:

        areaScope:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea'

            #Choice 2 timeWindow

       - type: object

      properties:

        timeWindow:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'

       #todo: stage 2 attribute definition missing

    SupportedLearningTechnology:

      type: object
@@ -271,7 +282,8 @@ components: 
              - FL

              - DL

            readOnly: true

        supportedEnvironment:

        supportedRLEnvironment:

          description: Included when RL is supported.

          type: array

          uniqueItems: true

          items:
@@ -280,7 +292,18 @@ components: 
              - SIMULATION_ENVIONMENTS

              - REAL_NETWORK_ENVIONMENTS

            readOnly: true

        supportedFLRole:

          description: Included when FL is supported.

          type: array

          uniqueItems: true

          items:

            type: string

            enum: [FL_SERVER, FL_CLIENT]

          minItems: 1

          maxItems: 2

          readOnly: true

        supportedInferenceNameList:

          description: Types of inference the training technologies can be applied to.

          type: array

          uniqueItems: true

          items:
@@ -328,6 +351,77 @@ components: 
          maxItems: 1

        preferredModelDiversity:

          type: string

    FLParticipationInfo:

      type: object

      additionalProperties: false

      properties:

        fLRole:

          type: string

          enum: [FL_SERVER, FL_CLIENT]

          readOnly: true

        isAvailableForFLTraining:

          type: boolean

          default: FALSE

          readOnly: true

        candidateFLClientRefList:

          description: >

            List of MLTrainingFunction DNs capable of acting as FL clients.

            Applicable when fLRole = FL_SERVER.

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' 

    FLRequirement:

      type: object

      additionalProperties: false

      properties:

        fLClientSelectionCriteria:

          type: array

          uniqueItems: true

          items:

            $ref: '#/components/schemas/FLClientSelectionCriteria'

          minItems: 1

    FLClientSelectionCriteria:

      type: object

      additionalProperties: false

      properties:

        minimumAvailableDataSamples:

          type: integer

        minimumAvailableTimeDuration:

          type: integer

          description: Minutes

        minimumInterimModelPerformance:

          type: array

          uniqueItems: true

          items:

            $ref: '#/components/schemas/ModelPerformance'

        servingGeoArea:

          type: array

          uniqueItems: true

          items:

            $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea'

        clientRedundancy:

          type: boolean

        trainingDataWithOrWithoutOutliers:

          type: boolean

          default: FALSE

        uniformlyDistributedTrainingData:

          type: boolean

          default: FALSE

      required:

        - minimumAvailableDataSamples

        - minimumAvailableTimeDuration     

    FLReportPerClient:

      type: object

      additionalProperties: false

      properties:

        clientRef:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

        numberOfDataSamplesUsed:

          type: integer

        trainingTimeDuration:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'

        modelPerformanceOnClient:

          type: array

          items:

            $ref: '#/components/schemas/ModelPerformance'     



#-------- Definition of types for name-containments ------

    SubNetwork-ncO-AiMlNrm: