Skip to content

Commit

Permalink
docs(readme): update installation instructions and badges (#299)
Browse files Browse the repository at this point in the history
* docs(readme): update installation instructions

* docs(docs): update installation instructions

* ci(github): update CI job name
  • Loading branch information
frgfm authored Dec 30, 2024
1 parent 93bb3fe commit 1fd89a0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/page-build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: GH-Pages Status
name: page-build
on:
page_build

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
</h1>

<p align="center">
<a href="https://github.com/frgfm/torch-cam/actions/workflows/builds.yml">
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/frgfm/torch-cam/builds.yml?branch=main&label=CI&logo=github&style=flat-square">
<a href="https://github.com/frgfm/torch-cam/actions/workflows/build.yml">
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/frgfm/torch-cam/build.yml?branch=main&label=CI&logo=github&style=flat-square">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/badge/Linter-Ruff-FCC21B?style=flat-square&logo=ruff&logoColor=white" alt="ruff">
Expand Down Expand Up @@ -39,7 +39,7 @@
</p>
<p align="center">
<a href="https://frgfm.github.io/torch-cam">
<img src="https://img.shields.io/github/actions/workflow/status/frgfm/torch-cam/docs.yaml?branch=main&label=Documentation&logo=read-the-docs&logoColor=white&style=flat-square" alt="Documentation Status">
<img src="https://img.shields.io/github/actions/workflow/status/frgfm/torch-cam/page-build.yml?branch=main&label=Documentation&logo=read-the-docs&logoColor=white&style=flat-square" alt="Documentation Status">
</a>
</p>

Expand Down Expand Up @@ -125,7 +125,7 @@ plt.imshow(result); plt.axis('off'); plt.tight_layout(); plt.show()

## Setup

Python 3.8 (or higher) and [pip](https://pip.pypa.io/en/stable/)/[conda](https://docs.conda.io/en/latest/miniconda.html) are required to install TorchCAM.
Python 3.9 (or higher) and [uv](https://docs.astral.sh/uv/)/[conda](https://docs.conda.io/en/latest/miniconda.html) are required to install TorchCAM.

### Stable release

Expand Down
8 changes: 4 additions & 4 deletions docs/source/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
Installation
************

This library requires `Python <https://www.python.org/downloads/>`_ 3.8 or higher.
This library requires `Python <https://www.python.org/downloads/>`_ 3.9 or higher.

Via Python Package
==================

Install the last stable release of the package using `pip <https://pip.pypa.io/en/stable/installation/>`_:
Install the last stable release of the package using `uv <https://docs.astral.sh/uv/>`_:

.. code:: bash
pip install torchcam
uv pip install torchcam
Via Conda
Expand All @@ -33,4 +33,4 @@ Install the library in developer mode:
.. code:: bash
git clone https://github.com/frgfm/torch-cam.git
pip install -e torch-cam/.
uv pip install -e torch-cam/.

0 comments on commit 1fd89a0

Please sign in to comment.