Skip to content

Commit

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

* docs(docs): update installation instructions

* ci(github): upate CI job name
  • Loading branch information
frgfm authored Dec 30, 2024
1 parent c0de9a0 commit cbe2ac6
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 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
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
</p>

<p align="center">
<a href="https://github.com/frgfm/Holocron/actions/workflows/builds.yml">
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/frgfm/holocron/builds.yml?branch=main&label=CI&logo=github&style=flat-square">
<a href="https://github.com/frgfm/Holocron/actions/workflows/build.yml">
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/frgfm/holocron/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/holocron">
<img src="https://img.shields.io/github/actions/workflow/status/frgfm/holocron/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/holocron/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 @@ -88,7 +88,7 @@ print(config['classes'][output.squeeze(0).argmax().item()], output.squeeze(0).so

### Prerequisites

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 Holocron.
Python 3.9 (or higher) and [pip](https://pip.pypa.io/en/stable/)/[conda](https://docs.conda.io/en/latest/miniconda.html) are required to install Holocron.

### Latest stable release

Expand Down Expand Up @@ -211,7 +211,7 @@ python scripts/eval_latency.py rexnet1_0x
If you wish to deploy containerized environments, you can use the provided Dockerfile to build a docker image:

```shell
docker build . -t <YOUR_IMAGE_TAG>
make build-api
```

### Minimal API template
Expand All @@ -223,9 +223,7 @@ Looking for a boilerplate to deploy a model from Holocron with a REST API? Thank
Run your API in a docker container as follows:

```shell
cd api/
make lock-api
make run-api
make start-api
```

*In order to stop the container, use `make stop-api`*
Expand Down
2 changes: 1 addition & 1 deletion docs/source/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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
==================
Expand Down

0 comments on commit cbe2ac6

Please sign in to comment.