Skip to main content

A package for interpretable factor analysis

Project description

The interpretablefa package

Overview

This is a package, which is available on the Python Package Index, for performing interpretable factor analysis. This implements the priorimax rotation, including the associated interpretability index and plot, that are described here.

It also contains several helper and visualization functions and wraps several functions from the factor_analyzer package.

For more details about the methods implemented and some of the package's features, see Pairwise Target Rotation for Factor Models. The package's source code can be found here.

The linked paper provides some documentation to the package and docstrings are available. However, a comprehensive guide or documentation is still under development.

Example

For instance, suppose that data contains the dataset and q contains the questions. Then, one can fit a 4-factor priorimax model using the snippet below.

import pandas as pd
from interpretablefa import InterpretableFA

# Load the dataset and the questions
data = pd.read_csv("./data/ECR_data_clean.csv")
with open("./data/ECR_questions.txt") as questions_file:
    q = questions_file.read().split("\n")
    questions_file.close()

# Initialize the analyzer
analyzer = InterpretableFA(data)

# Fit the 4-factor model with the priorimax rotation
analyzer.fit_factor_model("model", 4, "priorimax", q)

# Get the results
print(analyzer.calculate_indices("model")["v_index"])
print(analyzer.models["model"].rotation_matrix_)

# Visualize the results
analyzer.var_factor_corr_plot("model")
analyzer.interp_plot("model")

Requirements

  • Python 3.8 or higher
  • numpy
  • pandas
  • scikit-learn
  • factor_analyzer
  • tensorflow_hub
  • scipy
  • seaborn
  • matplotlib
  • statsmodels

License

GNU General Public License 3.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

interpretablefa-6.0.5.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

interpretablefa-6.0.5-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file interpretablefa-6.0.5.tar.gz.

File metadata

  • Download URL: interpretablefa-6.0.5.tar.gz
  • Upload date:
  • Size: 28.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for interpretablefa-6.0.5.tar.gz
Algorithm Hash digest
SHA256 a6877a09c6bc965f84d323c36c63cd344f99ae7fe69f52d90df96f6114a20c1e
MD5 7cbc0270f8a0e38f2b05bebb3adc5391
BLAKE2b-256 607bfeca99da1251136409966b6414ced2de15e4d1d536e489a047630cc9ad8f

See more details on using hashes here.

File details

Details for the file interpretablefa-6.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for interpretablefa-6.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 32cd6939c109ffe5552a2bac936fa04bbc289c23d081140a799ec7b83c7d1773
MD5 0c9daa68fded96ac37c110b4a34277e1
BLAKE2b-256 1115dd5762a544bb3ab127267dbd394e3c2bc1700cf39fd33a8f0e1feaaa08fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page