Synced repo using 'sync_with_huggingface' Github Action

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Titusz Pan
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

app.py

@@ -0,0 +1,179 @@
+import io
+import base64
+import gradio as gr
+import iscc_core as ic
+import iscc_sdk as idk
+from PIL import Image
+
+idk.sdk_opts.image_thumbnail_size = 265
+idk.sdk_opts.image_thumbnail_quality = 80
+idk.sdk_opts.granular = True
+
+
+custom_css = """
+.fixed-height img {
+    height: 265px;  /* Fixed height */
+    object-fit: contain;  /* Scale the image to fit within the element */
+}
+#chunked-text span.label {
+    text-transform: none !important;
+}
+"""
+
+newline_symbols = {
+    "\u000a": "⏎",  # Line Feed - Represented by the 'Return' symbol
+    "\u000b": "↨",  # Vertical Tab - Represented by the 'Up Down Arrow' symbol
+    "\u000c": "␌",  # Form Feed - Unicode Control Pictures representation
+    "\u000d": "↵",  # Carriage Return - 'Downwards Arrow with Corner Leftwards' symbol
+    "\u0085": "⤓",  # Next Line - 'Downwards Arrow with Double Stroke' symbol
+    "\u2028": "↲",  # Line Separator - 'Downwards Arrow with Tip Leftwards' symbol
+    "\u2029": "¶",  # Paragraph Separator - Represented by the 'Pilcrow' symbol
+}
+
+
+def no_nl(text):
+    for char, symbol in newline_symbols.items():
+        text = text.replace(char, symbol)
+    return text
+
+
+def generate_iscc(file):
+    imeta = idk.code_iscc(file.name)
+    thumbnail = None
+    if imeta.thumbnail:
+        header, encoded = imeta.thumbnail.split(",", 1)
+        data = base64.b64decode(encoded)
+        thumbnail = Image.open(io.BytesIO(data))
+    metadata = imeta.dict(exclude_unset=False, by_alias=True)
+    if metadata.get("thumbnail"):
+        del metadata['thumbnail']
+    return imeta.iscc, thumbnail, metadata
+
+
+def explain_iscc(code):
+    canonical = ic.iscc_normalize(code)
+    human = " - ".join(ic.iscc_explain(code).split("-"))
+    code_obj = ic.Code(canonical)
+    decomposed = " - ".join(ic.iscc_decompose(canonical))
+    multiformat = code_obj.mf_base58btc
+    return canonical, human, decomposed, multiformat
+
+
+def generate_text_code(text, chunk_size):
+    original_chunk_size = idk.sdk_opts.text_avg_chunk_size
+    idk.sdk_opts.text_avg_chunk_size = chunk_size
+    cleaned = ic.text_clean(text)
+    processed = idk.text_features(cleaned)
+    features = processed["features"]
+    sizes = processed["sizes"]
+    start = 0
+    chunks = []
+    for size in sizes:
+        end = start + size
+        chunks.append(no_nl(cleaned[start:end]))
+        start = end
+    result = [(chunk, f"{size}:{feat}") for chunk, size, feat in zip(chunks, sizes, features)]
+    idk.sdk_opts.text_avg_chunk_size = original_chunk_size
+    return result
+
+
+with gr.Blocks(title="ISCC-CODE") as demo_generate:
+    gr.Markdown("""
+    ## 🌟 ISCC-CODE Generator - The DNA of digital content
+    """)
+    with gr.Row():
+        with gr.Column(scale=2):
+            in_file = gr.File(label="Media File")
+        with gr.Column(scale=1):
+            out_thumbnail = gr.Image(label="Extracted Thumbnail", elem_classes=["fixed-height"])
+    with gr.Row():
+        out_iscc = gr.Text(label="ISCC-CODE", show_copy_button=True)
+    with gr.Row():
+        out_meta = gr.Json(label="Metadata")
+    in_file.change(generate_iscc, inputs=[in_file], outputs=[out_iscc, out_thumbnail, out_meta])
+
+
+with gr.Blocks("ENCODING") as demo_decode:
+    gr.Markdown("""
+    ## 🌟 A Codec for Self-Describing Compact Binary Codes
+    """)
+    with gr.Row():
+        with gr.Column():
+            in_iscc = gr.Text(
+                label="ISCC",
+                info="INPUT ANY VALID ISCC-CODE OR ISCC-UNIT",
+                autofocus=True,
+            )
+            examples = [
+                "ISCC:AAAWN77F727NXSUS",  # Meta-Code
+                "bzqaqaal5rvp72lx2thvq",  # Multiformat
+                "ISCC:EAASKDNZNYGUUF5A",  # Text-Code
+                "ISCC:GABW5LUBVP23N3DOD7PPINHT5JKBI",  # Data-Code 128 bits
+                "ISCC:KUAG5LUBVP23N3DOHCHWIYGXVN7ZS",  # ISCC-SUM
+                "ISCC:KAA2Y5NUST7BFD5NN2XIDK7VW3WG4OEPMRQNPK37TE",  # ISCC-CDI
+                "z36hVxiqoF8AAmDpZV958hn3tsv2i7v1NfCrSzpq",  # ISCC-CDI multiformats
+                "ISCC:KACT4EBWK27737D2AYCJRAL5Z36G76RFRMO4554RU26HZ4ORJGIVHDI",
+            ]
+            gr.Examples(label="Example ISCCs", examples=examples, inputs=[in_iscc])
+
+    gr.Markdown("## Different Encodings:")
+    with gr.Row():
+        with gr.Column():
+            out_canonical = gr.Text(
+                label="Canonical",
+                info="NORMALIZED STANDARD REPRESENTATION",
+                show_copy_button=True,
+            )
+            out_human = gr.Text(
+                label="Human Readable",
+                info="MAINTYPE - SUBTYPE - VERSION - LENGTH - BODY",
+                show_copy_button=True,
+            )
+            out_decomposed = gr.Text(
+                label="Decomposed",
+                info="ISCC-UNITS",
+                show_copy_button=True,
+            )
+            out_multiformat = gr.Text(
+                label="Multiformat",
+                info="BASE58-BTC",
+                show_copy_button=True,
+            )
+    in_iscc.change(explain_iscc, inputs=[in_iscc], outputs=[
+        out_canonical,
+        out_human,
+        out_decomposed,
+        out_multiformat,
+    ])
+
+with gr.Blocks(title="CHUNKING") as demo_text_code:
+    gr.Markdown("""
+    ## 🌟 Content Defined Chunking for Shift-Resistant Text and Data Segmentation
+    """)
+    with gr.Row():
+        with gr.Column():
+            in_text = gr.Textbox(label="Text Input", lines=8, autofocus=True)
+            in_chunksize = gr.Slider(
+                label="Chunk Size",
+                info="AVERAGE NUMBER OF CHARACTERS PER CHUNK",
+                minimum=32, maximum=2048, step=32,
+                value=64)
+
+        out_text = gr.HighlightedText(
+            label="Chunked Text Output",
+            interactive=False,
+            elem_id="chunked-text",
+        )
+    in_text.change(generate_text_code, inputs=[in_text, in_chunksize], outputs=[out_text])
+    in_chunksize.change(generate_text_code, inputs=[in_text, in_chunksize], outputs=[out_text])
+
+demo = gr.TabbedInterface(
+    title="▶️ ISCC Playground",
+    interface_list=[demo_generate, demo_decode, demo_text_code],
+    tab_names=["ISCC-CODE", "ENCODING", "CHUNKING"],
+    css=custom_css,
+)
+
+if __name__ == '__main__':
+    demo.launch(debug=True, show_api=True)
+

pyproject.toml

@@ -0,0 +1,16 @@
+[tool.poetry]
+name = "iscc-playground"
+version = "0.1.0"
+description = "UI for ISCC exploration"
+authors = ["Titusz <tp@py7.de>"]
+license = "Apache-2.0"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+gradio = "^4.12.0"
+iscc-sdk = "^0.6.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

requirements.txt

@@ -0,0 +1 @@
+iscc-sdk==0.6.0