caetas / flow-ms

Flow-MS official repository.

Flow-MS

A short description of the project. No quotes.

Prerequisites

You will need:

• python (see pyproject.toml for full version)
• Git
• Make
• a .secrets file with the required secrets and credentials
• load environment variables from .env

Installation

Clone this repository (requires git ssh keys)

git clone --recursive [email protected]:caetas/GenerativeZoo.git
cd generativezoo

Install dependencies

conda env create -f environment.yml
conda activate python3.10

On Linux

And then setup all virtualenv using make file recipe

(python3.10) $ make setup-all

You might be required to run the following command once to setup the automatic activation of the conda environment and the virtualenv:

direnv allow

Feel free to edit the .envrc file if you prefer to activate the environments manually.

On Windows

You can setup the virtualenv by running the following commands:

python -m venv .venv-dev
.venv-dev/Scripts/Activate.ps1
python -m pip install --upgrade pip setuptools
pip install torch torchvision --index-url https://download.pytorch.org/whl/cu121
python -m pip install -r requirements/requirements-win.txt

To run the code please remember to always activate both environments:

conda activate python3.10
.venv-dev/Scripts/Activate.ps1

Documentation

Full documentation is available here: docs/.

Dev

See the Developer guidelines for more information.

Contributing

Contributions of any kind are welcome. Please read CONTRIBUTING.md for details and the process for submitting pull requests to us.

Changelog

See the Changelog for more information.

Security

Thank you for improving the security of the project, please see the Security Policy for more information.

License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

Citation

If you publish work that uses Flow-MS, please cite Flow-MS as follows:

@misc{Flow-MS,
  author = {TUE},
  title = {A short description of the project. No quotes.},
  year = {2024},
}