API
Download
- Please visit the repository: https://github.com/Thomas-uestc/API
- Download the tempate archive 'Template.zip' from the repository
Description of Folders
- datasets: This folder should hold the raw datasets used for the project.
- export: This folder is for files that include models.
- result: This folder is for pretrained model parameters
- mats: This directory stores MATLAB-related files, such as
.matfiles or other results generated during computation. - your script: Your script should be placed at the same level as 'export'
Usage Guide for dulrs Package
The dulrs package provides tools to calculate and visualize some evaluation matrix (heatmap, low-rankness, sparsity)of our models on various scenarios from different datasets.
Installation
First, install the package using pip:
pip install dulrs
Importing the Package
Import the package in your Python script:
from dulrs import dulrs_class
Available Functions
The package includes the following functions:
dulrs_class(model_name, model_path, use_cuda=True, num_stages=6)dulrs_class.heatmap(img_path, data_name,output_mat,output_png)dulrs_class.lowrank_cal(img_path, model_name, data_name, save_dir)dulrs_class.lowrank_draw(model_name, data_name, mat_dir, save_dir)dulrs_class.sparsity_cal(img_path, model_name, data_name, save_dir)
Function Descriptions and Examples
0. dulrs_class(model_name, model_path, use_cuda=True, num_stages=6)
The dulrs_class in the dulrs package is used to initialize the models with pretrained parameters and including following functions.
1. dulrs_class.heatmap(img_path, data_name, output_mat, output_png)
The dulrs_class.heatmap function in the dulrs package allows users to draw and save the heatmaps obtained from different stages.
2. dulrs_class.lowrank_cal(img_path, model_name, data_name, save_dir)
The dulrs_class.lowrank_cal function in the dulrs package allows users to calculate and save the low-rankness data with mat format.
3. dulrs_class.lowrank_draw(model_name, data_name, mat_dir, save_dir)
The dulrs_class.lowrank_draw function in the dulrs package allows users to draw the low-rankness figure based on the calculated low-rankess data and save with png format.
4. dulrs_class.sparsity_cal(img_path, model_name, data_name, save_dir)
The dulrs_class.sparsity_cal function in the dulrs package allows users to calculate and save the sparsity data with mat format.
Function Parameters
The dulrs_class accepts the following parameters:
model_name: refer to the model which is under evaluation.model_path: the pretrained parameters pkl path.use_cuda: Determine whether to use GPU for acceleration.num_stages: Specifie the number of stages to save.
The dulrs_class.heatmap function accepts the following parameters:
img_path: refer to the testing image.data_name: refer to the identifier of the test image.output_mat: path to save results in .mat format.output_png: path to save results in .png format.
The dulrs_class.lowrank_cal function accepts the following parameters:
img_path: refer to the testing image set.model_name: refer to the model which is under evaluation.data_name: refer to the identifier of the test image.save_dir: path to save results in .mat format.
The dulrs_class.lowrank_draw function accepts the following parameters:
model_name: refer to the model which is under evaluation.data_name: refer to the identifier of the test image.mat_dir: refer to the path for low-rankess result.save_dir: path to save results in .png format.
The dulrs_class.sparsity_cal function accepts the following parameters:
img_path: refer to the testing image set.model_name: refer to the model which is under evaluation.data_name: refer to the identifier of the test image.save_dir: path to save results in .mat format.
Examples
- Model: RPCANet_pp
Please follow the instructions below to set up the dataset and run the model:
📥 Download Dataset
Download the dataset from the following link:
📎 Google Drive - IRSTD-1k Dataset
📂 Directory Setup
After downloading:
- Extract the contents of the archive.
- Place the extracted dataset folder into the following path:
./datasets/
📜 Script Placement
Ensure that the main execution script is placed in the same directory as the export file.
📌 Example directory structure:
. ├── export/ ├── your_main_script.py └── datasets/ └── [IRSTD-1k]
📜 Script Example
from dulrs import dulrs_class
import torch
# Set CUDA as default device
torch.set_default_tensor_type('torch.cuda.FloatTensor' if torch.cuda.is_available() else 'torch.FloatTensor')
dulrs = dulrs_class(
model_name="rpcanet_pp",
model_path="./result/ISTD/1K/s6_best.pkl", # Path for pretrained parameters
num_stages=6,
use_cuda=True)
# For heatmap generation
heatmap = dulrs.heatmap(
img_path="./datasets/IRSTD-1k/test/images/000009.png",
data_name="IRSTD-1k_test_images_000009",
output_mat="./heatmap/mat", # If users want to save the data as .mat format. Default=None
output_png="./heatmap/png" # If users want to save the figure as .png format. Default=None
)
# For lowrank calculation
lowrank_matrix = dulrs.lowrank_cal(
img_path="./datasets/IRSTD-1k/test/images",
model_name="rpcanet_pp",
data_name="IRSTD-1k",
save_dir= "./mats/lowrank"
)
# For lowrank paint based on calculation
lowrank_matrix_draw = dulrs.lowrank_draw(
model_name="rpcanet_pp",
data_name="IRSTD-1k",
mat_dir= './mats/lowrank',
save_dir = './mats/lowrank/figure' # Path to save results in .png format
)
# For sparsity calculation
sparsity_matrix = dulrs.sparsity_cal(
img_path="./datasets/IRSTD-1k/test/images",
model_name="rpcanet_pp",
data_name="IRSTD-1k",
save_dir = './mats/sparsity' # Path to save results in .mat format
)
Metadata
Release files for dulrs 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dulrs-0.1.2.tar.gz | 12.1 kB | Without provenance | Details for dulrs-0.1.2.tar.gz |
Release files / dulrs-0.1.2.tar.gz
| Download URL | dulrs-0.1.2.tar.gz |
|---|---|
| Size | 12.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
133ea19f29afb5b082c03c30e7e73f127d6a802265bdeb57c4eca2f590aa04fc
|
|
BLAKE2b-256 checksum How to use checksums |
6fbdbf7af0a30b0bc42cd88d38f2de3f5f5b6dfd663bc52637180d597e9eaeaf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.8.20
|
Security for dulrs 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.