Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Add a small header description listing main features
Add more detailed installation instructions
  • Loading branch information
cpvannier committed Nov 15, 2023
1 parent 6457046 commit 2e680f5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ All notable changes to Pixano will be documented in this file.

### Changed

- Update README with a small header description listing main features and more detailed installation instructions
- Generate API reference automatically
- Update documentation website accent color to complementary color of the Pixano main accent color
- Add cross-references to Pixano, TensorFlow, and Hugging Face Transformers in the API reference of the documentation website
Expand Down
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

<br/>

**Inference models for Pixano,**

**Data-centric AI building blocks for computer vision applications**
**Inference models for Pixano**

**_Under active development, subject to API change_**

Expand All @@ -17,15 +15,36 @@

</div>

# Installing Pixano Inference
<hr />

<a href="https://github.com/pixano/pixano" target="_blank">Pixano</a> is an open-source tool by CEA List for exploring and annotating your dataset using AI features like **smart segmentation** and **semantic search**.

This library provides the AI models like _SAM_ and _CLIP_ that power those features, as well as a PyTorch and TensorFlow models for pre-annotating your datasets.

# Getting started

## Installing Pixano Inference

As Pixano and Pixano Inference require specific versions for their dependencies, we recommend creating a new Python virtual environment to install them.

For example, with <a href="https://conda.io/projects/conda/en/latest/user-guide/install/index.html" target="_blank">conda</a>:

```shell
conda create -n pixano_env python=3.10
conda activate pixano_env
```

Then, you can install Pixano Inference inside that environment with pip:

```shell
pip install pixano-inference@git+https://github.com/pixano/pixano-inference
```

# Using Pixano Inference
As it is a requirement of Pixano Inference, Pixano will automatically be downloaded if it is not already installed.

## Using the models

Please refer to [these Pixano notebooks](https://github.com/pixano/pixano/tree/main/notebooks/models) for information on how to use the inference models provided by this module.
Please refer to <a href="https://github.com/pixano/pixano/tree/main/notebooks/models" target="_blank">these notebooks</a> for information on how to use the models provided by Pixano Inference.

# Contributing

Expand Down

0 comments on commit 2e680f5

Please sign in to comment.