License Json

Authoring a License.json

License.json must be a valid JSON file.

You can use this web form to help you author a license.json

https://acumos-license-editor.stackblitz.io

../../../../_images/acumos-license-editor-v1.gif

This is also an example license.json that can be used:

{
  "modelLicenses": [
    {
      "keyword": "Company A",
      "intro": "Commercial License for Company A. Legal Text",
      "copyright": {
        "year": 2019,
        "company": "Company A",
        "suffix": "All rights reserved."
      },
      "swidTag": "Acumos Ai/ML Model|Data",
      "modelId": "AB123456",
      "licenseType": "trythenbuy|purchasemodel|purchaseartifacts",
      "rights": [
        {
          "id": "location",
          "name": "Locations Allowed",
          "desc": "The right to use this software is granted for the specified allowed locations",
          "limit": {
            "type": "location",
            "value": [
              "China,Europe,United States"
            ]
          }
        }
      ],
      "contact": {
        "desc": "Contact Company @ sales@companya.com To accquire the right to use this software"
      },
      "fullLegalLicense": "All legal text|url"
    }
  ],
  "contentLicenses": [
    {
      "keyword": "CC0 license",
      "path": "image-classification/data/cropped_panda.jpg",
      "source": "https://pixabay.com/en/animal-branch-cute-leaves-outdoors-1852789/"
    }
  ]
}

Schema for License.json (wip)

This is a schema that we have in progress. In Clio release the schema will change.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "modelLicenses": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "keyword": {
              "type": "string"
            },
            "intro": {
              "type": "string"
            },
            "URL": {
              "type": "string"
            },
            "warranty": {
              "type": "string"
            },
            "copyright": {
              "type": "object",
              "properties": {
                "year": {
                  "type": "integer"
                },
                "company": {
                  "type": "string"
                },
                "suffix": {
                  "type": "string"
                }
              }
            },
            "swidTag": {
              "type": "string"
            },
            "modelId": {
              "type": "string"
            },
            "modelLimits": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "desc": {
                      "type": "string"
                    },
                    "limit": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "value": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "desc": {
                      "type": "string"
                    },
                    "limit": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "value": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "desc": {
                      "type": "string"
                    },
                    "limit": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "value": {
                          "type": "array",
                          "items": [
                            {
                              "type": "string"
                            }
                          ]
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "desc": {
                      "type": "string"
                    },
                    "limit": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "value": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "desc": {
                      "type": "string"
                    },
                    "limit": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "value": {
                          "type": "integer"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "desc": {
                      "type": "string"
                    },
                    "limit": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "value": {
                          "type": "integer"
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      ]
    },
    "contentLicenses": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "keyword": {
              "type": "string"
            },
            "path": {
              "type": "string"
            },
            "source": {
              "type": "string"
            }
          }
        }
      ]
    }
  },
  "required": [
    "modelLicenses"
  ]
}

Attaching a License.json with a model

  • During onboarding you can onboard a model with a license.json file.
../../../../_images/attach-license.gif
  • After onboarding or after creating a composite model you can add a license.json.
../../../../_images/attach-before-publishing.gif

Viewing the License Json in portal

../../../../_images/view-license-in-portal.png