tico 0.1.0.dev250411__py3-none-any.whl → 0.1.0.dev250414__py3-none-any.whl

tico/__init__.py

@@ -22,7 +22,7 @@ from tico.config import CompileConfigV1, get_default_config
 from tico.utils.convert import convert, convert_from_exported_program, convert_from_pt2
 
 # THIS LINE IS AUTOMATICALLY GENERATED BY setup.py
-__version__ = '0.1.0.dev250411'
+__version__ = '0.1.0.dev250414'
 
 
 if Version(torch.__version__) < Version("2.5.0"):

tico-0.1.0.dev250414.dist-info/METADATA

@@ -0,0 +1,297 @@
+Metadata-Version: 2.1
+Name: tico
+Version: 0.1.0.dev250414
+Summary: Convert exported Torch module to circle
+Home-page: UNKNOWN
+License: UNKNOWN
+Platform: UNKNOWN
+Requires-Python: >=3.10.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cffi
+Requires-Dist: circle-schema
+Requires-Dist: packaging
+Requires-Dist: pyyaml
+Requires-Dist: torch
+
+# TICO
+
+_TICO_ (Torch IR to Circle [ONE](https://github.com/Samsung/ONE)) is a python library for converting 
+ Pytorch modules into a circle model that is a lightweight and efficient representation in ONE 
+designed for optimized on-device neural network inference.
+
+## Table of Contents
+
+### For Users
+
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+  - [From torch module](#from-torch-module)
+  - [From .pt2](#from-pt2)
+  - [Running circle models directly in Python](#running-circle-models-directly-in-python)
+
+### For Developers
+
+- [Testing & Code Formatting](#testing--code-formatting)
+- [Testing](#testing)
+- [Code Formatting](#code-formatting)
+
+## For Users
+
+### Installation
+
+0. Prerequisites
+
+- Python 3.10
+- [one-compiler nightly](https://github.com/Samsung/TICO/issues/2)
+  - This project depends on [ONE](https://github.com/Samsung/ONE) Compiler, and it uses 
+  nightly features that are not yet available in the official release. Until one-compiler 1.30.0
+  is released, you must use a prebuilt nighlty version of ONE Compiler.
+
+We highly recommend to use a virtual env, e.g., conda.
+
+1. Clone this repo
+
+2. Build python package
+
+```bash
+./ccex build
+```
+
+This will generate `build` and `dist` directories in the root directory.
+
+3. Install generated package
+
+```bash
+./ccex install
+```
+
+**Available options**
+- `--dist` To install the package from .whl (without this option, _TICO_ is installed in an editable mode)
+- `--torch_ver <torch version>` To install a specific torch version (default: 2.6).
+  - Available <torch version>: 2.5, 2.6, nightly
+
+4. Now you can convert a torch module to a `.circle`.
+
+### Getting started
+
+This tutorial explains how you can use _TICO_ to generate a circle model from a torch module. 
+
+Let's assume we have a torch module.
+
+```python
+import tico
+import torch
+
+class AddModule(torch.nn.Module):
+    def __init__(self):
+        super().__init__()
+
+    def forward(self, x, y):
+        return x + y
+```
+
+**NOTE**
+_TICO_ internally uses [torch.export](https://pytorch.org/docs/stable/export.html#torch-export).
+Therefore, the torch module must be 'export'able. Please see 
+[this document](https://pytorch.org/docs/stable/export.html#limitations-of-torch-export) 
+if you have any trouble to export.
+
+#### From torch module
+
+You can convert a torch module to a circle model with these steps.
+
+```python
+torch_module = AddModule()
+example_inputs = (torch.ones(4), torch.ones(4))
+
+circle_model = tico.convert(torch_module, example_inputs)
+circle_model.save('add.circle')
+```
+
+**Compile with configuration**
+
+```python
+from test.modules.op.add import AddWithCausalMaskFolded
+
+torch_module = AddWithCausalMaskFolded()
+example_inputs = torch_module.get_example_inputs()
+
+config = tico.CompileConfigV1()
+config.legalize_causal_mask_value = True
+circle_model = tico.convert(torch_module, example_inputs, config = config)
+circle_model.save('add_causal_mask_m120.circle')
+```
+
+With `legalize_causal_mask_value` option on, causal mask value is converted from 
+ -inf to -120, creating a more quantization-friendly circle model with the cost of 
+slight accuracy drop.
+
+#### From .pt2
+
+The torch module can be exported and saved as `.pt2` file (from PyTorch 2.1).
+
+```python
+module = AddModule()
+example_inputs = (torch.ones(4), torch.ones(4))
+
+exported_program = torch.export.export(module, example_inputs)
+torch.export.save(exported_program, 'add.pt2')
+```
+
+There are two ways to convert `.pt2` file: python api, command line tool.
+
+- Python API
+
+```python
+circle_model = tico.convert_from_pt2('add.pt2')
+circle_model.save('add.circle')
+```
+
+- Command Line Tool
+
+```bash
+pt2-to-circle -i add.pt2 -o add.circle
+```
+
+- Command Line Tool with configuration
+
+```bash
+pt2-to-circle -i add.pt2 -o add.circle -c config.yaml
+```
+
+```yaml
+# config.yaml
+
+version: '1.0' # You must specify the config version. 
+legalize_causal_mask_value: True
+```
+
+#### Running circle models directly in Python
+
+After circle export, you can run the model directly in Python.
+
+Note that you should install one-compiler package first.
+
+The output types are numpy.ndarray.
+
+```python
+torch_module = AddModule()
+example_inputs = (torch.ones(4), torch.ones(4))
+
+circle_model = tico.convert(torch_module, example_inputs)
+circle_model(*example_inputs)
+# numpy.ndarray([2., 2., 2., 2.], dtype=float32)
+```
+
+## For Developers
+
+### Testing & Code Formatting
+
+Run below commands to configure testing or formatting environment.
+
+Refer to the dedicated section to have more fine-grained control.
+
+```bash
+$ ./ccex configure                          # to set up testing & formatting environment
+$ ./ccex configure format                   # to set up only formatting environment
+$ ./ccex configure test                     # to set up only testing environment
+```
+
+**Available options**
+- `--torch_ver <torch version>` To install a specific torch family package(ex. torchvision) version (default: 2.6)
+  - Available <torch version>: '2.5', '2.6', 'nightly'
+
+```bash
+$ ./ccex configure                          # to set up testing & formatting environment with stable2.6.x version
+$ ./ccex configure test                     # to set up only testing environment with stable 2.6.x version
+$ ./ccex configure test --torch_ver 2.5     # to set up only testing environment with stable 2.5.x version
+$ ./ccex configure test --torch_ver nightly     # to set up only testing environment with nightly version
+```
+
+### Testing
+
+#### Test congifure
+
+Run below commands to install requirements for testing.
+
+**NOTE** `TICO` will be installed in an editable mode.
+
+```bash
+./ccex configure test
+
+# without editable install
+./ccex configure test --dist
+```
+
+#### Test All
+
+Run below commands to run the all unit tests.
+
+**NOTE** Unit tests don't include model test.
+
+```bash
+./ccex test
+# OR
+./ccex test run-all-tests
+```
+
+#### Test Subset
+
+To run subset of `test.modules.*`,
+Run `./ccex test -k <keyword>`
+
+
+For example, to run tests in specific sub-directory (op, net, ..)
+```bash
+# To run tests in specific sub-directory (op/, net/ ..)
+./ccex test -k op
+./ccex test -k net
+
+# To run tests in one file (single/op/add, single/op/sub, ...)
+./ccex test -k add
+./ccex test -k sub
+
+# To run SimpleAdd test in test/modules/single/op/add.py
+./ccex test -k SimpleAdd
+```
+
+To see the full debug log, add `-v` or `TICO_LOG=4`.
+
+```bash
+TICO_LOG=4 ./ccex test -k add
+# OR
+./ccex test -v -k add
+```
+
+#### Test Model
+
+If you want to test them locally, you can do so by navigating to each model directory, 
+ installing the dependencies listed in its `requirements.txt`, and running the tests one by one.
+```bash
+$ pip install -r test/modules/model/<model_name>/requirements.txt
+# Run test for a single model
+$ ./ccex test -m <model_name>
+```
+
+For example, to run a single model
+```
+./ccex test -m InceptionV3
+```
+
+### Code Formatting
+
+#### Format configure
+
+Run below commands to install requirements for formatting.
+
+```bash
+./ccex configure format
+```
+
+#### Format run
+
+```bash
+./ccex format
+```
+

{tico-0.1.0.dev250411.dist-info → tico-0.1.0.dev250414.dist-info}/RECORD

@@ -1,4 +1,4 @@
-tico/__init__.py,sha256=3ox6RnlXIaWboX14JLH-rtpN5tkKhFYvkxQ9RjZwaYo,1181
+tico/__init__.py,sha256=drwOk40YiN-xglot_aW8vG4uxq2GWx4F853Gxd6Jdv0,1181
 tico/pt2_to_circle.py,sha256=PPmFNw20jw2Z2VyM3ln9pX__jTzBOAZiv0gT5a-p-Y8,2666
 tico/config/__init__.py,sha256=xZzCXjZ84qE-CsBi-dfaL05bqpQ3stKKfTXhnrJRyVs,142
 tico/config/base.py,sha256=anwOiJFkUxUi7Cef573JgQcjk6S-FSi6O_TLjYASW-g,1244
@@ -188,9 +188,9 @@ tico/utils/register_custom_op.py,sha256=FbMcrg8o5vKWC_aoVxL2GrIcR14KFi1yKG0mFGqX
 tico/utils/trace_decorators.py,sha256=ddLIiKQfSaQrxgF1kNpwjFTQnXENzeSfcr1kuAW4jGI,3221
 tico/utils/utils.py,sha256=pybDU1LoNhjEplANig11lboX9yzYRkvFCSmyYth_2Do,10359
 tico/utils/validate_args_kwargs.py,sha256=DXW7W5x-6pQR43_q4EFoeWE5pn1Nm7gNsrzaO5avm4k,24724
-tico-0.1.0.dev250411.dist-info/LICENSE,sha256=dAq6L2M49W6wEPmkyVtYxE3Omm3oInXPd6qw5mQX6wY,12644
-tico-0.1.0.dev250411.dist-info/METADATA,sha256=0QMEluiyKjjlcPwY-ONXF-zpMHPUUz65amgjaay7A8A,336
-tico-0.1.0.dev250411.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-tico-0.1.0.dev250411.dist-info/entry_points.txt,sha256=kBKYSS_IYrSXmUYevmmepqIVPScq5vF8ulQRu3I_Zf0,59
-tico-0.1.0.dev250411.dist-info/top_level.txt,sha256=oqs7UPoNSKZEwqsX8B-KAWdQwfAa7i60pbxW_Jk7P3w,5
-tico-0.1.0.dev250411.dist-info/RECORD,,
+tico-0.1.0.dev250414.dist-info/LICENSE,sha256=dAq6L2M49W6wEPmkyVtYxE3Omm3oInXPd6qw5mQX6wY,12644
+tico-0.1.0.dev250414.dist-info/METADATA,sha256=NxIJgt_iKq8KOz07g5VLVRyCv7Q9UQXJYML-EWcQYoY,7353
+tico-0.1.0.dev250414.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+tico-0.1.0.dev250414.dist-info/entry_points.txt,sha256=kBKYSS_IYrSXmUYevmmepqIVPScq5vF8ulQRu3I_Zf0,59
+tico-0.1.0.dev250414.dist-info/top_level.txt,sha256=oqs7UPoNSKZEwqsX8B-KAWdQwfAa7i60pbxW_Jk7P3w,5
+tico-0.1.0.dev250414.dist-info/RECORD,,

tico-0.1.0.dev250411.dist-info/METADATA

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: tico
-Version: 0.1.0.dev250411
-Summary: Convert exported Torch module to circle
-Home-page: UNKNOWN
-License: UNKNOWN
-Platform: UNKNOWN
-Requires-Python: >=3.10.0
-License-File: LICENSE
-Requires-Dist: cffi
-Requires-Dist: circle-schema
-Requires-Dist: packaging
-Requires-Dist: pyyaml
-Requires-Dist: torch
-
-UNKNOWN
-