:tada: Uploaded fully trained model

README.md

@@ -1,3 +1,74 @@
 ---
 license: apache-2.0
+tags:
+- jax
+- safetensors
 ---
+
+# Parametric PerceptNet Fully Trained
+
+## Model Description
+
+## How to use it
+
+### Install the model's package from source:
+```
+git clone https://github.com/Jorgvt/paramperceptnet.git
+cd paramperceptnet
+pip install -e .
+```
+
+### 1.Import necessary libraries:
+
+```
+import json
+
+from huggingface_hub import hf_hub_download
+import flax
+import orbax.checkpoint
+from ml_collections import ConfigDict
+
+from paramperceptnet.models import PerceptNet
+```
+
+### 2.Download the configuration
+
+```
+config_path = hf_hub_download(repo_id="Jorgvt/ppnet-fully-trained",
+                              filename="config.json")
+with open(config_path, "r") as f:
+    config = ConfigDict(json.load(f))
+```
+
+### 3. Download the weights
+
+#### 3.1. Using `safetensors`
+
+```
+from safetensors.flax import load_file
+
+weights_path = hf_hub_download(repo_id="Jorgvt/ppnet-fully-trained",
+                               filename="weights.safetensors")
+variables = load_file(weights_path)
+variables = flax.traverse_util.unflatten_dict(variables, sep=".")
+state = variables["state"]
+params = variables["params"]
+```
+
+#### 3.2. Using `mgspack`
+```
+weights_path = hf_hub_download(repo_id="Jorgvt/ppnet-fully-trained",
+                               filename="weights.msgpack")
+with open(weights_path, "rb") as f:
+    variables = orbax.checkpoint.msgpack_utils.msgpack_restore(f.read())
+variables = jax.tree_util.tree_map(lambda x: jnp.array(x), variables)
+state = variables["state"]
+params = variables["params"]
+```
+
+### 4. Use the model
+
+```
+from jax import numpy as jnp
+pred = model.apply({"params": params, **state}, jnp.ones((1,384,512,3)))
+```

config.json

@@ -0,0 +1 @@
+{"A_GABOR": true, "A_GDNSPATIOFREQORIENT": true, "BATCH_SIZE": 64, "CS_KERNEL_SIZE": 21, "END_LR": 0.005, "EPOCHS": 500, "GABOR_KERNEL_SIZE": 31, "GDNFINAL_KERNEL_SIZE": 21, "GDNGAUSSIAN_KERNEL_SIZE": 11, "GDN_CLIPPING": true, "INITIAL_LR": 0.01, "INIT_GABOR": true, "INIT_JH": true, "LEARNING_RATE": 0.003, "NORMALIZE_ENERGY": true, "NORMALIZE_PROB": false, "PEAK_LR": 0.04, "SEED": 42, "TRAIN_CS": true, "TRAIN_GABOR": true, "TRAIN_GDNCOLOR": false, "TRAIN_GDNGAMMA": true, "TRAIN_GDNGAUSSIAN": true, "TRAIN_JH": true, "TRAIN_ONLY_LAST_GDN": false, "USE_BIAS": false, "USE_GAMMA": true, "WARMUP_EPOCHS": 15, "ZERO_MEAN": true}

weights.msgpack

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6e331558c13e18656a6c1688e3fee2eeab7057260cd9301362b87a95b7ac9fd2
+size 1724898

weights.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:44866a40fa4e0ada8a5db1991c395df904e24dbe52da2edb1f8110a054aa8e7e
+size 1727968