thinkingmachines/unicef-ai4d-research-bank

As a data scientist / data analyst / programme specialist, I want to see a list of all models / results in the catalogue

butchtm opened this issue · 4 comments

What I want:

As a data scientist / data analyst / programme specialist, I want to see a list of all models in the catalogue

I will know that this works when

  • There's a web interface to provide me with a list of all the models / datasets in the catalogue
  • The list is structured in some useful way
  • There's sufficient metadata about the models for me to filter / choose the one I'm interested in (e.g. It's labelled by country, thematic area, etc)

Stretch Goal

  • Data Scientist / Data Analyst: There's an API that provides the same information in a structured format
  • Data Scientist / Data Analyst: The API provides me links to an endpoint for retrieving this model / data

Questions:

  • How do we sort the models / datasets in the catalogue by default? (Alphabetical?)
  • What kinds of filters do we want to be included? (country, theme, year?)
  • When filtering, do we want to allow users to search or filter for BOTH models and datasets simultaneously? (e.g. I will get both models and datasets as results) Or do we want to limit search or filter to each of their own catalogues only? (e.g. search and filter only happens in the catalogue pages)
  • What kinds of datasets are we adding in the data catalogue?
  • Alphabetical is fine
  • Filters are: Country, Date (Created / Updated), 'tags'
  • Tags are just a typeahead find
  • What kinds of datasets - Use Air Quality and Poverty as a rough template - It'll have a description, a link to the code, a link to the results.

Task Breakdown:

  • Create a searchbox
  • Create a page listing catalog results
    • filters: country, created-date, updated-date, organization
    • search by tags
  • Create a catalog card page
  • Create an link that lists all the contents of the catalog in a json format
  • Create an action that can merge all the catalog items in a folder to a single json file
  • Add javascript code that reads the single json file to the web app
  • Add javascript code that update the page listing the catalog results with the contents from the json file