Configure Renovate

.github/dco.yml

@@ -0,0 +1,4 @@
+# This enables DCO bot for you, please take a look https://github.com/probot/dco
+# for more details.
+require:
+  members: false

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  push:
+    branches: [ "master", "main"]
+  pull_request:
+    branches: [ "master", "main"]
+    paths-ignore:
+      - '*.md'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.11]
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Runs a single command using the runners shell
+      - name: Run a one-line script
+        run: echo Hello, world!
+
+      # Runs a set of commands using the runners shell
+      - name: Run a multi-line script
+        run: |
+          echo Add other actions to build,
+          echo test, and deploy your project.

.gitignore

@@ -0,0 +1,9 @@
+.env
+*.pyc
+*.lock
+.DS_Store
+**/.DS_Store
+__pycache__/
+.ipynb_checkpoints/
+.DS_Store
+build/

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/ibm/detect-secrets
+    # If you desire to use a specific version of detect-secrets, you can replace `master` with other git revisions such as branch, tag or commit sha.
+    # You are encouraged to use static refs such as tags, instead of branch name
+    #
+    # Running "pre-commit autoupdate" automatically updates rev to latest tag
+    rev: 0.13.1+ibm.61.dss
+    hooks:
+      - id: detect-secrets # pragma: whitelist secret
+        # Add options for detect-secrets-hook binary. You can run `detect-secrets-hook --help` to list out all possible options.
+        # You may also run `pre-commit run detect-secrets` to preview the scan result.
+        # when "--baseline" without "--use-all-plugins", pre-commit scan with just plugins in baseline file
+        # when "--baseline" with "--use-all-plugins", pre-commit scan with all available plugins
+        # add "--fail-on-unaudited" to fail pre-commit for unaudited potential secrets
+        args: [--baseline, .secrets.baseline, --use-all-plugins]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-added-large-files
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)
+        args: ["--profile", "black", "--filter-files"]

.secrets.baseline

@@ -0,0 +1,195 @@
+{
+  "exclude": {
+    "files": "^.secrets.baseline$",
+    "lines": null
+  },
+  "generated_at": "2025-07-26T17:25:52Z",
+  "plugins_used": [
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "base64_limit": 4.5,
+      "name": "Base64HighEntropyString"
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "BoxDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "ghe_instance": "github.ibm.com",
+      "name": "GheDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "hex_limit": 3,
+      "name": "HexHighEntropyString"
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "keyword_exclude": null,
+      "name": "KeywordDetector"
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "results": {
+    "examples/cell/quick_start.ipynb": [
+      {
+        "hashed_secret": "4c61efabc4bc81ec84c795041277855a85b0910f",
+        "is_verified": false,
+        "line_number": 14,
+        "type": "Base64 High Entropy String",
+        "verified_result": null
+      }
+    ],
+    "examples/mexgen/RAG.ipynb": [
+      {
+        "hashed_secret": "7edab97170fc278bf247ccb7bef43ad6967a918d",
+        "is_verified": false,
+        "line_number": 177,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "9028b37e27d728088edc9015e035e69c29a523d4",
+        "is_verified": false,
+        "line_number": 179,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "b8b2f0d03f04cd29909f6a0088c2b72324d4f2fb",
+        "is_verified": false,
+        "line_number": 1317,
+        "type": "Base64 High Entropy String",
+        "verified_result": null
+      }
+    ],
+    "examples/mexgen/question_answering.ipynb": [
+      {
+        "hashed_secret": "7edab97170fc278bf247ccb7bef43ad6967a918d",
+        "is_verified": false,
+        "line_number": 156,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "9028b37e27d728088edc9015e035e69c29a523d4",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 158,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "a5923e427937f5c02a9d8f8f5d28d8169da85a9f",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 1250,
+        "type": "Base64 High Entropy String",
+        "verified_result": null
+      }
+    ],
+    "examples/mexgen/quick_start.ipynb": [
+      {
+        "hashed_secret": "aceeac92b0b2f105eaf709fc7b76ca968bc99e83",
+        "is_verified": false,
+        "line_number": 38,
+        "type": "Base64 High Entropy String",
+        "verified_result": null
+      }
+    ],
+    "examples/mexgen/summarization.ipynb": [
+      {
+        "hashed_secret": "7edab97170fc278bf247ccb7bef43ad6967a918d",
+        "is_verified": false,
+        "line_number": 157,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "9028b37e27d728088edc9015e035e69c29a523d4",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 159,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "f768b4853bb1d7614d66a01cd89b88fd435ad75e",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 1664,
+        "type": "Base64 High Entropy String",
+        "verified_result": null
+      }
+    ],
+    "examples/th/LLM_jailbreak.ipynb": [
+      {
+        "hashed_secret": "065cdbb11677efb7dd6c66b73a20d3246a9d4fe3",
+        "is_verified": false,
+        "line_number": 14,
+        "type": "Base64 High Entropy String",
+        "verified_result": null
+      }
+    ],
+    "examples/th/quick_start.ipynb": [
+      {
+        "hashed_secret": "065cdbb11677efb7dd6c66b73a20d3246a9d4fe3",
+        "is_verified": false,
+        "line_number": 14,
+        "type": "Base64 High Entropy String",
+        "verified_result": null
+      }
+    ]
+  },
+  "version": "0.13.1+ibm.61.dss",
+  "word_list": {
+    "file": null,
+    "hash": null
+  }
+}

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## Version 0.0.1 (2024-12-17)
+
+## What's Changed
+
+⚠️ Some alert
+
+### :tada: New Features / Improvements
+* chore: Add read me
+
+### :bug: Fixes
+
+### :package: Dependency updates
+
+### :wrench: Maintenance
+
+### :heavy_plus_sign: Other Changes

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing
+
+[fork]: https://github.com/IBM/ICX360/fork
+[pr]: https://github.com/IBM/ICX360/compare
+[released]: https://help.github.com/articles/github-terms-of-service/
+
+We are pleased that you would like to contribute to ICX360. We welcome both reporting issues and submitting pull requests.
+
+## Reporting issues
+Please make sure to include any potentially useful information in the issue, so we can pinpoint the issue faster without going back and forth.
+
+- What SHA of ICX360 are you running? If this is not the latest SHA on the main branch, please try if the problem persists with the latest version.
+- Python versions
+
+## Contributing a change
+Contributions to this project are [released][released] to the public under the project's [opensource license](https://github.com/IBM/ICX360/blob/main/LICENSE).
+
+Contributors must _sign off_ that they adhere to these requirements by adding a `Signed-off-by` line to all commit messages with an email address that matches the commit author:
+
+```
+feat: this is my commit message
+
+Signed-off-by: Random J Developer <random@developer.example.org>
+```
+
+
+Coding Style Guidelines
+We are using tools to enforce code style:
+- iSort, to sort imports
+- Black, to format code
+
+We run a series of checks on the codebase on every commit using pre-commit. To install the hooks, run:
+`pre-commit install`
+
+To run the checks on-demand, run:
+`pre-commit run --all-files`
+
+## Contributing to documentation
+`uv pip install  -e ".[docs]"`
+
+We use [MkDocs](https://www.mkdocs.org/) to write documentation.
+
+To run the documentation server, run:
+
+```bash
+mkdocs serve
+```
+
+The server will be available at [http://localhost:8000](http://localhost:8000).
+
+### Pushing Documentation to GitHub Pages
+
+Run the following:
+
+```bash
+mkdocs gh-deploy
+```
+
+
+## Submitting a pull request
+
+1. [Fork][fork] and clone the repository
+2. Create a new branch: `git checkout -b my-branch-name`
+3. Make your change, push to your fork and [submit a pull request][pr]
+4. Wait for your pull request to be reviewed and merged.