Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test and review models in catalogue #542

Open
14 of 20 tasks
ots22 opened this issue Apr 20, 2023 · 7 comments
Open
14 of 20 tasks

Test and review models in catalogue #542

ots22 opened this issue Apr 20, 2023 · 7 comments
Assignees
Milestone

Comments

@ots22
Copy link
Member

ots22 commented Apr 20, 2023

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 ots22 added this to the Core features milestone Apr 20, 2023
@ots22 ots22 changed the title Test and review scivision gallery notebooks Test and review models in catalogue Apr 20, 2023
@ots22
Copy link
Member Author

ots22 commented Apr 26, 2023

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

@IFenton

@ots22
Copy link
Member Author

ots22 commented Apr 26, 2023

Also discussed earlier:

  • the gallery examples should all include a environment.yml (or requirements.txt, but might be some advantage to these all being consistent).
  • there should be a specification of all packages and their complete versions in the environment somewhere, including secondary dependencies, and including scivision itself. This could be in the files above, or somewhere else (e.g. make an 'environment-lock.yml', and keep 'environment.yml' for describing the immediate dependencies with ranged versions).

@IFenton
Copy link
Contributor

IFenton commented Apr 27, 2023

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
Copy link
Contributor

IFenton commented Jul 10, 2023

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

@ots22
Copy link
Member Author

ots22 commented Aug 24, 2023

huggingface-classifiers

  • dependencies in requirements.txt can be trimmed
  • pip installing safetensors (dependency of transformers) attempts to use the source distribution, rather than the wheel (there seem to be several mac wheels on https://pypi.org/project/safetensors/#files) - fails when it can't find a rust compiler

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:

  • update requirements.txt (I'm ignoring any environment.yml in any model repo)

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
Copy link
Member Author

ots22 commented Aug 24, 2023

Will mark this one one done

@ots22
Copy link
Member Author

ots22 commented Aug 24, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment