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

Update README.md #37

Merged
merged 5 commits into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,36 @@
# <div align="left"><img src="https://rapids.ai/assets/images/rapids_logo.png" width="90px"/>&nbsp;pynvjitlink</div>
# <div align="left"><img src="img/rapids_logo.png" width="90px"/>&nbsp;pynvjitlink</div>
vyasr marked this conversation as resolved.
Show resolved Hide resolved

The [RAPIDS](https://rapids.ai) pynvjitlink library provides a Python binding for the
[nvJitLink library](https://docs.nvidia.com/cuda/nvJitLink/index.html). It is presently a
work-in-progress.
[nvJitLink library](https://docs.nvidia.com/cuda/nvJitLink/index.html).

**NOTE:** For the latest stable [README.md](https://github.com/rapidsai/pynvjitlink/blob/main/README.md) ensure you are on the `main` branch.
## Installation with pip

## Quick Start
TODO
```shell
pip install -i https://pypi.anaconda.org/rapidsai-wheels-nightly/simple pynvjitlink-cu12
bdice marked this conversation as resolved.
Show resolved Hide resolved
```

## Install pynvjitlink
## Installation from source

Install with either:

```shell
python -m pip install -e .
python -m pip install .
```

or

```shell
python -m pip install .
python -m pip install -e .
```

### Conda
TODO
for an editable install.

## Installation with Conda

### Docker
TODO

## Contributing Guide

Review the [CONTRIBUTING.md](https://github.com/rapidsai/pynvjitlink/blob/main/CONTRIBUTING.md) file for information on how to contribute code and issues to the project.
Review the
[CONTRIBUTING.md](https://github.com/rapidsai/pynvjitlink/blob/main/CONTRIBUTING.md)
file for information on how to contribute code and issues to the project.
Binary file added img/rapids_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.