diff --git a/README.md b/README.md index 552a48d..f71087a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # crossfit [![PyPI](https://img.shields.io/pypi/v/crossfit.svg)](https://pypi.org/project/crossfit/) -[![Changelog](https://img.shields.io/github/v/release/marcromeyn/crossfit?include_prereleases&label=changelog)](https://github.com/marcromeyn/crossfit/releases) -[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/marcromeyn/crossfit/blob/main/LICENSE) +[![Changelog](https://img.shields.io/github/v/release/rapidsai/crossfit?include_prereleases&label=changelog)](https://github.com/rapidsai/crossfit/releases) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/rapidsai/crossfit/blob/main/LICENSE) -Metric calculation library +Multi Node Multi GPU Offline Inference and metric calculation library ## Installation @@ -26,11 +26,12 @@ Usage instructions go here. ## Development -To contribute to this library, first checkout the code. Then create a new virtual environment: - - cd crossfit - python -m venv venv - source venv/bin/activate +To contribute to this library, first create a conda environment with the necessary dependencies: +``` +cd crossfit +mamba env create -f conda/environments/cuda_dev.yaml +conda activate crossfit_dev +``` Now install the dependencies and test dependencies: diff --git a/conda/environments/cuda_dev.yaml b/conda/environments/cuda_dev.yaml new file mode 100644 index 0000000..e092385 --- /dev/null +++ b/conda/environments/cuda_dev.yaml @@ -0,0 +1,32 @@ +name: crossfit_dev +channels: + - conda-forge + - rapidsai + - nvidia +dependencies: + - bandit + - black + - cuda-version=12.0 + - cudf>=24.4 + - cuml>=24.4 + - cupy>=12.0.0 + - dask-cuda>=24.4 + - dask-cudf>=24.4 + - flake8 + - isort + - pip + - pre_commit + - pylibraft>=24.4 + - pytest + - pytest-benchmark + - pytest-cov>=2 + - pytorch>=2.0 + - transformers + - tokenizers + - torchvision + - scikit-learn>=0.23.1 + - scipy + - setuptools>=61.0.0 + - sentence-transformers + - pip: + - pytrec-eval