Skip to content

mlexchange/mlex_dimension_reduction_pca

Repository files navigation

mlex_dimension_reduction

Dimension reduction algorithms using PCA for the MLExchange platform

Getting started

Set up a conda environment and install requirements:

conda create -n mlex_dimension_reduction_pca python=3.11
conda activate mlex_dimension_reduction_pca
pip install .

An example execution script is provided. To run it, first create a .env file based on .env.example, then run /example_run.sh.

Developer Setup

If you are developing this library, there are a few things to note.

  1. Install development dependencies:
pip install .
pip install ".[dev]"
  1. Install pre-commit This step will setup the pre-commit package. After this, commits will get run against flake8, black, isort.
pre-commit install
  1. (Optional) If you want to check what pre-commit would do before commiting, you can run:
pre-commit run --all-files
  1. To run test cases:
python -m pytest

Copyright

MLExchange Copyright (c) 2023, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Intellectual Property Office at [email protected].

NOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit others to do so.