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.9.tar.gz (28.4 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.9-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: interpretablefa-6.0.9.tar.gz
  • Upload date:
  • Size: 28.4 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.9.tar.gz
Algorithm Hash digest
SHA256 3f157d8ef256a87074a27716c4a13e45b821983ef7d8f1834ef7f537245deb22
MD5 28ad674f4c62db63dbde8eb0addfea21
BLAKE2b-256 160bcc41d2a5eb57ccadbad6f8adb452a0afb3865d416313c08b7a5f3ada01ad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for interpretablefa-6.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 861a66c6901682a1968c2946ae4fc73fe48dd2a607a3f6e48e0b08cdebcf3b30
MD5 8dfa3b3ff15bb4619f12fb4fc7fcfe68
BLAKE2b-256 24eb29a76a62d60fa0fd084de92a24c86babf93aee82094300368ee0feadceac

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