Update README.md

README.md

@@ -1,3 +1,86 @@
----
-license: mit
----
+---
+license: mit
+---
+---
+license: mit
+language:
+- en
+base_model:
+- CodeFormer
+pipeline_tag: frame 
+tags:
+- Image
+- Colorize
+---
+
+# CodeFormer
+
+This version of CoderFormer has been converted to run on the Axera NPU using **w8a16** quantization.
+
+This model has been optimized with the following LoRA: 
+
+Compatible with Pulsar2 version: 5.0-patch1
+
+## Convert tools links:
+
+For those who are interested in model conversion, you can try to export axmodel through 
+
+- [The repo of AXera Platform](https://github.com/AXERA-TECH/ax-samples), which you can get the detail of guide
+
+- [Pulsar2 Link, How to Convert ONNX to axmodel](https://pulsar2-docs.readthedocs.io/en/latest/pulsar2/introduction.html) 
+
+
+## Support Platform
+
+- AX650
+  - [M4N-Dock(爱芯派Pro)](https://wiki.sipeed.com/hardware/zh/maixIV/m4ndock/m4ndock.html)
+  - [M.2 Accelerator card](https://axcl-docs.readthedocs.io/zh-cn/latest/doc_guide_hardware.html)
+  
+|Chips|model|cost|
+|--|--|--|
+|AX650|coderformer|408 ms|
+
+## How to use
+
+Download all files from this repository to the device
+
+```
+
+root@ax650:~/coderformer# tree
+.
+|-- model
+|   `-- coderformer.axmodel
+|-- python
+|`-- run_axmodel.py
+|`-- requirements.txt
+
+
+
+```
+
+### Inference
+
+Input Data:
+|-- image
+|   `-- 1850Geography.jpg
+
+#### Inference with AX650 Host, such as M4N-Dock(爱芯派Pro)
+
+```
+root@ax650 ~/realesrgan #python3 run_axmodel.py --inputs_path ./images --model_path ./coderformer.axmodel
+
+[INFO] Available providers:  ['AxEngineExecutionProvider']
+[INFO] Using provider: AxEngineExecutionProvider
+[INFO] Chip type: ChipType.MC50
+[INFO] VNPU type: VNPUType.DISABLED
+[INFO] Engine version: 2.12.0s
+[INFO] Model type: 2 (triple core)
+[INFO] Compiler version: 5.0-patch1 681a0b38
+SR image save to `00_00.png`
+SR image save to `01_00.png`
+SR image save to `02_00.png`
+
+```
+
+Output: 
+![Example Image](image/results.png)