search

NatLibFi / Annif

Annif is a multi-algorithm automated subject indexing tool for libraries, archives and museums.
https://annif.org
Other
197 stars 41 forks source link

Add `/examples` directory to repository #756

Open juhoinkinen opened 9 months ago

juhoinkinen commented 9 months ago

We could have a directory containing some examples of Annif usage, like Pecos and 🤗 Transformers have.

We have a bunch of documentation and/or instructions (Annif-tutorial, Annif-corpora, Annif-wiki, API documentation...), not to mention various resources about Finto AI, but for a random repository browser they are not easily findable/noticeable or interesting. I think a directory named examples in the root of Annif repo could contain some usage examples in subdirectories as Jupyter notebooks or scripts. The directory could contain also some experiments we run for archiving.

Maybe git-submodules or subtree could be used to link some content from Annif-tutorial or Annif-corpora.

Some possible topics:

However, I see the exact risk of xkcd 15th standard; try to fix the situation where documentation have been scattered to many locations by creating yet another documentation location, which also needs to maintained...

osma commented 9 months ago

How about creating a wiki page called Examples with links to the resources you list, then adding a link to this page into the top level README? This way wouldn't involve adding yet another location for documentation.

As a sidenote, I think the existing documentation could use better interlinking. The tutorial should link to relevant pages in the wiki and vice versa.