-
Notifications
You must be signed in to change notification settings - Fork 7
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
New Fractal task list page that uses the task metadata #871
Comments
Some comments Data retrievalThere exist very different approaches to data retrieval for this page (sorted by increasing complexity):
Options 2 and 3 are small but full-fledged web application, with quite some additional complexity (hosting, authentication, ..) UIIndependently on the choice above, we can always offer a richer and more interactive visualization. The simplest example is likely a table with some kind sort/filter/show/hide features, or otherwise we could explore a different UI like https://bioimage.io. Who should or should not consumes this pageA clear audience for this page is "whoever is interested in Fractal", either current or perspective users. This audience would visit the page directly, in their browser. Once this page is built, it will be tempting to say "let's expose this information in the fractal frontend as well, so that a user knows which task packages are available and can install directly from there". My opinion is strongly against this approach, where a "lightweight" landing page then turns into a critical component of actual deployments. If we want to discuss about a public registry of Fractal tasks (to be integrated with Fractal components), then we should design it as such. |
One additional feature: Also displaying images for each task that are saved per task somehow |
Maybe more towards: Make it easy for Fractal admins to update e.g. a list of task packages that then get rendered nicely |
Discussion to be had on whether this is an end goal for this feature. Certainly not the initial goal. |
Here is a prototype: https://tcompa.github.io/test-table-github-page (it's a minimal-working example, with no attempt to make it "nice"). All work was with @mfranzon. Data retrievalData are retrieved based on the following list of sources
The different kinds of sources have different properties:
There is one more data source that we could enable, which is the URL of a manifest. That one is very easy to parse, but it carries no information about the package version. For instance the manifest which is in My opinion here is that we encourage/nudge task developers to publish at least some wheels (or even on pypi) - and provide all kind of help and support to make it easy. UIThe UI is admittedly very basic, but it's good as a proof of concept for how we would display data. AttributesI only included the basic attributes that we already have. We can obviously expand this list, and find the best possible ways of displaying additional information. For each required attribute, I would first need to know:
|
@tcompa Awesome to see this experimentation with it. Even this table surely is already very useful!
+1 on this in general, this addition to the template will help with this: fractal-analytics-platform/fractal-tasks-template#18 If we need to update the listing for specific versions, that seems very suboptimal. But I can see the "manifest in main is different from released version" can be a potential issue.
The initial things I'm thinking about: |
I'd say the recent additions to https://github.com/fractal-analytics-platform/fractal-analytics-platform.github.io and the now available https://fractal-analytics-platform.github.io/fractal_tasks/ show that this issue can be successfully closed :) |
With the work on task metadata progressing (see #853) and work on showing task packages in Fractal web starting (see fractal-analytics-platform/fractal-web#654), we should also start thinking about how we'll showcase what tasks are available on the web.
I'm not looking for a quick-fix here, but let's start the larger conversation on where we want this to go. We have a decent start with our current task overview page:
It has some limitations:
My long-term goal would be that we have a great overview page of all the available Fractal task which uses the richer metadata to be searchable, browsable etc. This page should be a starting point for "will Fractal be able to solve my image analysis problem".
This page doesn't need to live in tasks-core documentation. Maybe it's part of the Fractal splash page? Or we make a whole new page just dedicated to this?
Brainstorming, mocks & prototyping is welcome! We can also list more requirements here.
cc @zonia3000 @tcompa @lorenzocerrone
The text was updated successfully, but these errors were encountered: