facultyai / facultyai/lens

Improve documentation

Aberta
#7 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Python
Estrelas
99
Forks
8
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

Currently the docs are comprised of a tutorial rendered from a notebook, and an API reference built form the python docstrings. We should expand the docs to include:

- [ ] An introduction to lens.
- [ ] A motivation of the choice of precomputing the summary vs computing it on-the-fly. Advantages of using dask?
- [ ] Tutorial for computing a summary and using the `Summary` and `Explorer` classes.
- [ ] Contribution guidelines.
- [ ] Structure API docs in a more clear way.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.