Skip to main content

Explore and analyze large datasets of images

Project description

Panoptic 👀

PyPI - Version PyPI - Python Version

This documentation also exist in French

Preview

Panoptic is a tool for exploring and annotating large image corpora, using image analysis and machine learning tools to facilitate these tasks.

Since it requires deep learning libraries, it is recommended to use it with a computer with minimal computing capabilities.

Caution: Panoptic is still in active development and is currently a prototype, it is likely that you will encounter bugs, so we recommend to use this tool only for testing and not to rely on it for a substantial academic work.

Windows and Linux installation

Python 3.9 or higher is required, and a custom environnment (venv, pyenv, conda etc.) is recommended. Open a terminal and type:

  • pip install panoptic
  • panoptic

Mac installation

Just like the windows installation but you will need to also install the xcode tools first. For this, just use this command in a terminal: xcode-select –-install, it should trigger the installation of the command line tools. Then run:

  • pip install panoptic
  • panoptic

Docker installation

If you're having issues with the installation (sometimes the packages can be tricky) or if you just prefair to use Docker it's possible: Start by installing docker:

Option 1 : One folder to rule them all

Make a folder for the docker with a subfolder for the images /path/to/your/folder/images.

docker run -it -p 8000:8000 -v /path/to/your/folder:/data --name panoptic ceressorbonne/panoptic

Option 2 : Separate data and images folders

Make a folder for the panoptic datas (database, thumbnails, etc.) /path/to/your/data/. And another one withe your images (could be an existing one) /path/to/your/images/.

docker run -it -p 8000:8000 \
-v /path/to/your/data:/data \
-v /path/to/your/images:/data/images \
--name panoptic \
ceressorbonne/panoptic

Access

You can now access panoptic through: https://localhost:8000 As if you were to launch it with the python version

Restart

If you happen to stop panoptic, you can re launch it with :

docker start -ia panoptic

Installation (development)

The following steps involve cloning the directory and are recommended for users who wish to have access to the development versions, or who wish to modify the code themselves in order to contribute.

Backend development only

To test and modify the backend operation, we provide an already built frontend in the backend html folder.

  • go to the panoptic-back folder
  • to install the dependencies
    • python setup.py install to simply use panoptic
    • pip install -e . to develop
    • pip install -r requirements.txt and you have to add panoptic-back to the PYTHON_PATH for developping purpose too
  • run python panoptic/main.py

Front and back development

  1. First of all, perform the installation steps of the backend
  2. go to the panoptic-front folder
  3. Run npm install.
  4. run npm run dev.
  5. before running the backend the PANOPTIC_ENV environment variable should be set to DEV in order to use the development frontend.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

panoptic-0.3.4.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

panoptic-0.3.4-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file panoptic-0.3.4.tar.gz.

File metadata

  • Download URL: panoptic-0.3.4.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for panoptic-0.3.4.tar.gz
Algorithm Hash digest
SHA256 f8d96156a497a122a1ff4d4c575ffff93005e77f619360d2226a05c692ed9753
MD5 6d13e9e08fb01941602fcdb54438fd0a
BLAKE2b-256 a4d30a7373029c5eb6adc2ec70f2bab31ec189d6f594dde03ca56e19ee9824e1

See more details on using hashes here.

File details

Details for the file panoptic-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: panoptic-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for panoptic-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2ace53970d95727900a5413c60f4e0b2b8b6863e9b29808d67f5694129c3396c
MD5 799b11da00f78943172b7324075424eb
BLAKE2b-256 aefdf7696e95032b162594253215fc60edb84998753aafa07379f46b302b5e1e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page