openminted / Open-Call-Discussions

A central place for participants in the open calls to ask questions
2 stars 1 forks source link

Pubrunner hackathon #30

Closed jakelever closed 6 years ago

jakelever commented 6 years ago

Hi, it'd be great to have a meeting next week. I'd like to confirm how to test Docker-based applications.

greenwoodma commented 6 years ago

To make sure we are as well prepared as possible to help during the hackathon sessions could you please add/attach to this issue:

  1. The landing page URL of any component/workflow you have registered
  2. The OMTD-SHARE XML file for each component/workflow
  3. One or two sample documents that you expect to produce sensible output for your component/workflow
jakelever commented 6 years ago

Hi, we've got two Docker-based applications:

Ab3P with PubRunner

Landing Page: https://test.openminted.eu/landingPage/application/1c058b30-fff2-4ffc-99d8-1bf6422c155e OMTD-SHARE: Ab3PwithPubRunner.zip

OpenSesamIE with PubRunner

Landing page: https://test.openminted.eu/landingPage/application/ab4cd0ab-ef72-415b-9a79-7e07c27f1bb7 OMTD-SHARE: OpenSesamIEwithPubRunner.zip

And both those tools should give output from this example document: exampleInput.zip

And the associated Docker hub page for both: https://hub.docker.com/r/jakelever/pubrunner/

galanisd commented 6 years ago

Hello,

Galaxy is filled with old versions of wrappers for PubRunner because of this https://github.com/openminted/omtd-registry/issues/22 which makes the whole process of testing very difficult. @courado @antleb

So, I deleted all of them, then I deleted your apps from Registry and re-register them

I tested "Ab3P with PubRunner" with a corpus and FAILED...I got this message ./pubrunner/openminted/Ab3P.py: No such file or directory

The reason is that Galaxy creates a "working" dir and calls your component from there. See here for more info. https://github.com/openminted/Open-Call-Discussions/issues/28

@pennyl67 @greenwoodma @mandiayba @reckart We should add in the Docker spec that the executable is runnable/visible from everywhere in the container. It seems the most common problem so far ...

gkirtzou commented 6 years ago

@jakelever Both for the Ab3P with PubRunner and OpenSeasamIE with PubRunner, given your description I understand that your applications generate a single output document of tsv format containing only abbreviations/acronyms; thus to be semantically correct please change in the outputResourceInfo, the processingResourceType to lexicalConceptualResource, in the final version of the metadata.

gkirtzou commented 6 years ago

@jakelever Moreover, I would like to suggest to enrich the metadata for your application for better clarity and discoverability reasons with the following:

These type of information, would allow us to enrich also our OMTD ontology.

A couple of additional recommendations for the metadata:

jakelever commented 6 years ago

Thanks for digging into this.

@galanisd I've updated the Docker image and commands in the OMTD-SHARE so that the commands should work anywhere

@gkirtzou I've made your suggested changes to the OMTD-SHARE files.

gkirtzou commented 6 years ago

@jakelever could you please provide me the OMTD-SHARE files, to check again and see if everything is ok? Thanks

galanisd commented 6 years ago

I've updated the Docker image and commands in the OMTD-SHARE so that the commands should work anywhere

You uploaded them in test.openminted.eu? Landing pages?

jakelever commented 6 years ago

Hi, apologies I was teaching all of yesterday.

Here is the updated OMTD-SHARE files. They're from the updated components (through the original landing pages). And I've updated the Docker image at jakelever/pubrunner .

Ab3PwithPubRunner_v2.zip OpenSesamIEwithPubRunner_v2.zip

galanisd commented 6 years ago

Hi,

Traceback (most recent call last): File "/pubrunner/openminted/Ab3P", line 22, in <module> assert os.path.isdir(args.output) AssertionError

I am just guessing...Do you check if the provided output dir exists? The directory should be created if it does not exist. For some reason Galaxy is not creating it. See also https://github.com/openminted/Open-Call-Discussions/issues/28#issuecomment-381199289 we had the same issue.

Dimitris.

jakelever commented 6 years ago

@galanisd , yep that is correct. I've fixed that bug and updated the Docker image

gkirtzou commented 6 years ago

@jakelever As far as the metadata records, I have no further comments/recommendations. I am just waiting to verify via the testing performed by Dimitris that the information provided for running the components is correct, in order to consider them as final versions. Please in the final version, do not use the latest image for your components, but a versioned one. This way the platform will be able to claim reproducibility for your components.

galanisd commented 6 years ago

This is the landing page for PubRunner? https://test.openminted.eu/landingPage/application/1c058b30-fff2-4ffc-99d8-1bf6422c155e I got a "System error loading component (Server responded: Access is denied)" message.

I assume that the app is private and the latest version of OMTD Registry does not allow to anyone except the owner to get access. @antleb ?

@jakelever If you want you can make it public so that I can test.

jakelever commented 6 years ago

Hi @gkirtzou and @galanisd , I've updated the OMTD to use a versioned Docker image (jakelever/pubrunner:0.3.1). Attached are the OMTD XML files just in case. I've also made the two applications public.

Ab3PwithPubRunner_OMTD.zip OpenSesamIEwithPubRunner_OMTD.zip

galanisd commented 6 years ago

@jakelever Thanks! For some reason the update you did it didn't triggered the process of generating a new Galaxy wrapper (and deleting the old one). @antleb @courado

But no problem. I re-registered https://test.openminted.eu/landingPage/application/PubRunnerDGv3 and everything worked as expected.

Then I ran a test. PubRunner + Thalamus corpus and got results.

screenshot from 2018-04-24 14 41 59

The output is here https://test.openminted.eu/landingPage/lexical/4b747bd2-a9dc-4d58-ba1f-07b4844a6ef0

Unfortunately the option to download the result is not provided. Screenshot screenshot from 2018-04-24 14 51 38 @antleb @courado

However, I located the output in Galaxy and download it. Seems ok. ...please have look...

Galaxy10-component_output__abbreviations.tsv.zip

jakelever commented 6 years ago

@galanisd Thank you for testing this out

pennyl67 commented 6 years ago

@jakelever You can now proceed to the uploading of your final applications at services.openminted.eu. If you have any problems, please let us know. Thanks

pennyl67 commented 6 years ago

@jakelever My mistake, please refrain from uploading at services.openminted.eu until further notice.

gkirtzou commented 6 years ago

Dear @jakelever you can now proceed to the uploading of your applications at https://services.openminted.eu/home

Just, one final suggestion for the metadata records is to add in both input and output resource info the language(s) that your application can handle.

If you encounter any problems, please let us know. Please also let me know when you have uploaded the applications to the production site. Thanks!

gkirtzou commented 6 years ago

Please, when you upload your applications, please keep them private and send me the metadata here, so I could check them.

Also, you could add the deliverable from the tender call to your git-hub repository (if you have) and add them as documentation to the metadata of your software.

Thanks.

jakelever commented 6 years ago

@gkirtzou I uploaded the OMTD-SHARE files to the main platform (https://services.openminted.eu) but forgot that the "Make Public" flag is in the XML file. So I've inadvertently made both applications public and didn't make the suggested edits. I'm working on getting the ADAPT document finished so would attach that later. Is there any way they could be made private again?

Ab3P with PubRunner: https://services.openminted.eu/landingPage/application/1c058b30-fff2-4ffc-99d8-1bf6422c155e OpenSesamIE with PubRunner: https://services.openminted.eu/landingPage/application/ab4cd0ab-ef72-415b-9a79-7e07c27f1bb7

gkirtzou commented 6 years ago

@jakelever Unfortunately, you cannot revert them to private once you went public. I can try to contact the tech team of the registry and delete them, so you could reupload them as private. I will let you know when this is done.

Please if you adapt the documents with the suggestions, do send them to check independently whether the previous versions are still registered.

gkirtzou commented 6 years ago

@jakelever the suggestions I have proposed (language and add the deliverables as an extra documentation source) are optional. Do you want them to add them? If yes, let me know so I could ask to remove the apps. Otherwise, the are in good status and I was able to ran them perfectly in the platform. Let me know how you want to processed.

jakelever commented 6 years ago

@gkirtzou . It's fine. I'm happy with the status of the applications. If we have to make any updates in the future, I can add the metadata then.

gkirtzou commented 6 years ago

@jakelever As you wish. Your app have correct metadata and can run in the platform successfully. So I am closing the issue. Cheers.