pyCLAMs
pyCLAMs: An integrated Python toolkit for classifiability analysis [J]. SoftwareX, Volume 18, June 2022, 101007, doi: 10.1016/j.softx.2022.101007
https://doi.org/10.1016/j.softx.2022.101007
Warning
Since 0.3.x, we have reorganized the package structure. Any upper app should be revised accordingly.
Installation
pip install pyCLAMs pip install rpy2 Install the R runtime and the ECol library (https://github.com/lpfgarcia/ECoL).
Run 'install.packages("ECoL")' in R. It will take very long time. You must wait for the installation to complete.
Sometimes, you may want to change the CRAN mirror. Under the "Packages" menu, click "Set CRAN Mirror".
After installation, you can check by R command 'installed.packages()'.
How to use
Download the sample dataset from the /data folder Use the following sample code to use the package:
# import the library
import clams
# load the dataset or generate a toy dataset by X,y = mvg(md = 2)
df = pd.read_csv('sample.csv')
X = np.array(df.iloc[:,:-1]) # skip first and last cols
y = np.array(df.iloc[:,-1])
# get all metrics
clams.get_metrics(X,y) # Return a dictionary of all metrics
# get metrics as JSON
clams.get_json(X,y)
# get an html report and display in Jupyter notebook
from IPython.display import display, HTML
display(HTML(clams.get_html(X,y)))
Extra Material
A more friendly GUI tool based on pyCLAMs can be accessed at http://spacs.brahma.pub/research/CLA
Metrics added since the original publication
classification.Mean_KLD - mean KLD (Kullback-Leibler divergence) between ground truth and predicted one-hot encodings
correlation.r2 - R2, the R-squared effect size
test.CHISQ, test.CHISQ.log10, test.CHISQ.CHI2 - Chi-squared test
classification.McNemar, classification.McNemar.CHI2 - McNemar test on the groud-truth and classifier's prediction
1 maintainer
Metadata
1 maintainer
Release files for pyCLAMs 0.4.1
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 | |
|---|---|---|---|---|
| pyCLAMs-0.4.1.tar.gz | 22.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyCLAMs-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 45.5 kB
Release files / pyCLAMs-0.4.1.tar.gz
| Download URL | pyCLAMs-0.4.1.tar.gz |
|---|---|
| Size | 22.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b54a1435e408f85bb9ad753a7de7a7f24fc3969e139d35e41e18227f167cdd7
|
|
BLAKE2b-256 checksum How to use checksums |
42d7a6f20ae8e7b8062c07ec0b589f8f7bdad70eb8445a08b33cb65bd9562c5a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.12
|
Release files / pyCLAMs-0.4.1-py3-none-any.whl
| Download URL | pyCLAMs-0.4.1-py3-none-any.whl |
|---|---|
| Size | 22.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5020e673f1e565361b369f7317a93bc93cedbb1280e45e38d73a153ac798374e
|
|
BLAKE2b-256 checksum How to use checksums |
cf6de1f47fedb72ad96e2738a57d427cb808127e3370cfb921ef5b94dffb7dbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.12
|
Security for pyCLAMs 0.4.1
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.
