alan-turing-institute / scivision

scivision: a framework for scientific image analysis
https://sci.vision/
BSD 3-Clause "New" or "Revised" License
94 stars 40 forks source link

Test and review models in catalogue #542

Open ots22 opened 1 year ago

ots22 commented 1 year ago

Aim is to have all models in https://github.com/alan-turing-institute/scivision/blob/main/scivision/catalog/data/models.json working when they're loaded (or an indication that they are not supposed to, e.g. via "scivision_usable": false).

Start by working through the scivision examples gallery:

  1. Clone each of the repos in https://github.com/scivision-gallery
  2. Try to run each notebook according to the instructions
  3. Fix any easy to fix problems or update the documentation with extra steps needed
    • Consider updating dependencies (in environment.yml) - to the latest scivision package in particular
    • General 'code review' suggestions and clarity of the text
  4. Open issues (in those repos) for the harder problems and paste error messages/ screenshots etc: (example issue)
  5. Try the same for the catalogue models that don't have a corresponding notebook example

(Note: transferred from private https://github.com/alan-turing-institute/DS4S-project-management/issues/83)

Also consider the full set of models in the model catalog (note some typos need to be corrected to get some of these to run):

ots22 commented 1 year ago

A note to include a list of models here, grouped into 'works with pip', 'works with documented steps', 'broken'.

@IFenton

ots22 commented 1 year ago

Also discussed earlier:

IFenton commented 1 year ago

A note to include a list of models here, grouped into 'works with pip', 'works with documented steps', 'broken'.

@IFenton

These have now been added in the initial comment

IFenton commented 1 year ago

I've corrected the branch names where master was used rather than main and vice versa (see #585)

ots22 commented 1 year ago

huggingface-classifiers

Summary of notes below: conda default channel on mac only supports wheels tagged up to macosx_10, but there isn't one on PyPI for safetensors, making installation more difficult.

Suggest we don't include this example in the introductory notebook (since a chance it doesn't work smoothly first time), and maybe recommend using python from conda-forge in installation/setup instructions.

To-do before we can tick this one off:


Relevant docs https://peps.python.org/pep-0425/ https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/

Attempting to install directly from the wheel:

$ pip install safetensors-0.3.3-cp311-cp311-macosx_12_0_universal2.whl 
ERROR: safetensors-0.3.3-cp311-cp311-macosx_12_0_universal2.whl is not a supported wheel on this platform.

Running pip debug --verbose shows my platform supports various cp311-cp311-macosx_10_*_universal2 (but no macos_12_0)

Maybe-relevant issues:

~

ots22 commented 1 year ago

Will mark this one one done

ots22 commented 1 year ago

image-classifiers too (which also had some required versions relaxed)