Add list_spaces to HfApi

[cakiki]

First try; fixes #881. :-)
Reused the SpaceInfo class, but not sure that was the way to go because of unused fields:

SpaceInfo: {
	id: BigSalmon/Streamlit_Headline_Writer
	sha: None
	lastModified: None
	siblings: None
	private: None
	author: None
	sdk: streamlit
}

cc @osanseviero @LysandreJik

[HuggingFaceDocBuilderDev]

The documentation is not available anymore as the PR was closed or merged.

[osanseviero]

Overall this looks to go in the right direction! I would suggest to add a test for this 😄

[julien-c]

On the server API side, possible query params on that endpoint are:

• full (boolean) => will return in addition to the base props

  • author
  • sha
  • lastModified
  • cardData
  • tags

• datasets (boolean or string or array of strings which are dataset ids)

• models (boolean or string or array of strings which are model ids)

• datasets=true and models=true can be replaced with linked=true (boolean)

relevant internal PR for the model/dataset linking

Feel free to experiment with the API to see what it does!
Hope it's not too confusing!

[cakiki]

Should I be defining a new SpacesFilter class like this one: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/utils/endpoint_helpers.py#L67 ?

[julien-c]

@osanseviero @LysandreJik can chime in but i don't think so

[LysandreJik]

It's useful, but definitely not necessary. Having list_spaces is already a very nice first step!

[cakiki]

datasets=True and models=True doesn't seem to work (returns an empty list). Not sure if that's an implementation error on my side or an endpoint issue. Passing a dataset id or a model id works fine.

[julien-c]

looks good to me from a quick glance!

Thank you @cakiki!!

[julien-c]

hmm so @osanseviero made me realize i was mistaken, datasets (boolean) or models (boolean) are not supported

I only meant that if you pass models or datasets in your query (as string or array of string), then they will also be returned as fields in the API output.

Sorry about the incorrect information!

[osanseviero]

Very cool PR! I left some suggestions 😄

[osanseviero]

Looks good! I left some comments on the tests but otherwise looks almost ready to merge

[osanseviero]

Thank you @cakiki for the contribution!! 🔥 🔥

[julien-c]

Yay it's very cool!! thanks