[WIP] Create simpleHRT-example.json

[rgopikrishnan91]

This is a first attempt at writing an AI BOM. Need help with

1. Checking the integrity of the example
2. How to add licensing information

This AI BOM is for the application available here https://github.com/githubharald/SimpleHTR/tree/master

@kestewart

[bact]

@rgopikrishnan91 I made a PR to your branch here rgopikrishnan91#1 to fix few JSON errors.

[bact]

For licensing information, I guess it will look more or less like this:

    {
      "type": "Relationship",
      "spdxId": "urn:",
      "relationshipType": "hasConcludedLicense",
      "from": "...",
      "to": "CC-BY-4.0",
      "creationInfo": "_:creationinfo",
    },
    {
      "type": "Relationship",
      "spdxId": "urn:",
      "relationshipType": "hasDeclaredLicense",
      "from": "...",
      "to": "CC-BY-4.0",
      "creationInfo": "_:creationinfo",
    }

from should be the id of the element that has the licenses

What I'm not sure is the to that should we use the SPDX short name of the license or should it be some kind of IRI?

[rgopikrishnan91]

My problem is I am not sure how to define custom licenses and I think the dataset here needs a custom license

…

On Fri, May 24, 2024, 5:57 a.m. Arthit Suriyawongkul < ***@***.***> wrote: For licensing information, I guess it will look more or less like this: { "type": "Relationship", "spdxId": "urn:", "relationshipType": "concludedLicense", "from": "...", "to": "CC-BY-4.0", "creationInfo": "_:creationinfo", }, { "type": "Relationship", "spdxId": "urn:", "relationshipType": "declaredLicense", "from": "...", "to": "CC-BY-4.0", "creationInfo": "_:creationinfo", } from should be the id of the element that has the licenses What I'm not sure is the to that should we use the SPDX short name of the license or should it be some kind of IRI? — Reply to this email directly, view it on GitHub <#80 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABXOY6I6DXA4KY5HGORST7LZD4FJXAVCNFSM6AAAAABHUM5QF6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRZGEZDEMBRGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[bact]

My problem is I am not sure how to define custom licenses and I think the dataset here needs a custom license

Right. Maybe this one is going to be a complex example.

[bact]

I found that the dictionary entries is quite cumbersome for a big dictionary. Based on the work of Gopi's, I found that we have to have it like this...

            "ai_hyperparameter": [
                {
                    "type": "DictionaryEntry",
                    "key": "cnn_kernel_vals",
                    "value": "[5, 5, 3, 3, 3]"
                },
                {
                    "type": "DictionaryEntry",
                    "key": "cnn_nfeature_vals",
                    "value": "[1, 32, 64, 128, 128, 256]"
                }
            ]

Hopefully we will soon not have to do this by hand....

[bact]

Btw, good news, this example is now passed the validation by spdx3ToGraph (see rgopikrishnan91#1 )

However, due to a very long string (few of them are values in dictionary entries), because of the constraint of JSON string, PlantUML is unable to draw the diagram properly (the diagram got cropped).

[bact]

For custom license, I think it will probably look like this:

        {
            "type": "expandedlicensing_CustomLicense",
            "spdxId": "https://spdx.org/spdxdocs/CustomLicense-c63547c2-62e0-48ec-b98d-ff1b917d67db",
            "creationInfo": "_:creationinfo",
            "simplelicensing_licenseText": "This database may be used for non-commercial research purpose only. If you publish material based on this database, we request you to include a reference to paper. U. Marti and H. Bunke. The IAM-database: An English Sentence Database for Off-line Handwriting Recognition. Int. Journal on Document Analysis and Recognition, Volume 5, pages 39 - 46, 2002.",
            "expandedlicensing_isFsfLibre": false,
            "expandedlicensing_isOsiApproved": false
        },
        {
            "type": "Relationship",
            "spdxId": "https://spdx.org/spdxdocs/Relationship/declaredLicense-2c9563dc-baa1-4385-be02-ad671976a8aa",
            "creationInfo": "_:creationinfo",
            "relationshipType": "hasDeclaredLicense",
            "from": "https://my-first-aibom.com/IAMdataset",
            "to": "https://spdx.org/spdxdocs/CustomLicense-c63547c2-62e0-48ec-b98d-ff1b917d67db"
        },
        {
            "type": "Relationship",
            "spdxId": "https://spdx.org/spdxdocs/Relationship/concludedLicense-3bcfa4ce-6a65-46e8-bed1-18985211bb9e",
            "creationInfo": "_:creationinfo",
            "relationshipType": "hasConcludedLicense",
            "from": "https://my-first-aibom.com/IAMdataset",
            "to": "https://spdx.org/spdxdocs/CustomLicense-c63547c2-62e0-48ec-b98d-ff1b917d67db"
        },

The above snippet use CustomLicense but I think we can also use SimpleLicensingText as well.