Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix build instructions in README.md #61

Merged
merged 4 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When trying to create the environment I'm getting the following error:

(base) syurick@ipp1-3303:~/scratch/crossfit$ mamba env create -f conda/environments/cuda_dev.yaml
conda-forge/linux-64                                        Using cache
conda-forge/noarch                                          Using cache
nvidia/linux-64                                             Using cache
nvidia/noarch                                               Using cache
pkgs/r/linux-64                                               No change
pkgs/main/linux-64                                            No change
pkgs/main/noarch                                              No change
pkgs/r/noarch                                                 No change
rapidsai/linux-64                                             No change
rapidsai/noarch                                               No change


Looking for: ['bandit', 'black', 'cuda-version=12.0', "cudf[version='>=24.4']", "cuml[version='>=24.4']", "cupy[version='>=12.0.0']", 'dev', "dask-cuda[version='>=24.4']", "dask-cudf[version='>=24.4']", 'flake8', 'isort', 'pip', "pylibraft[version='>=24.4']", 'pytest', 'pytest-benchmark', "pytest-cov[version='>=2']", "pytorch[version='>=2.0']", 'transformers', 'tokenizers', 'torchvision', "scikit-learn[version='>=0.23.1']", 'scipy', "setuptools[version='>=61.0.0']", 'sentence-transformers', 'pip==-=pytrec_eval']


Encountered problems while solving:
  - nothing provides requested dev
  - nothing provides requested pip ==- pytrec_eval

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be resolved now: 18fe8b2, tested it locally

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, works now!

conda activate crossfit_dev
```

Now install the dependencies and test dependencies:

Expand Down
32 changes: 32 additions & 0 deletions conda/environments/cuda_dev.yaml
Original file line number Diff line number Diff line change
@@ -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
Loading