Skip to content

Doc indexing #633

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

Merged
merged 19 commits into from
Feb 10, 2022
Merged

Doc indexing #633

merged 19 commits into from
Feb 10, 2022

Conversation

hepengfe
Copy link
Collaborator

@hepengfe hepengfe commented Feb 9, 2022

This PR creates a indexing page for tutorials.

Description of changes

  • create a indexing page
  • move tutorials into folders under tutorial folder

Possible influences of this PR.

Current we don't have a structured tutorial indexing page, and it's hard for beginners to find tutorial they want.
This PR creates a indexing page helping them find tutorials suit users' needs.

Test Conducted

No test needed.

@codecov
Copy link

codecov bot commented Feb 9, 2022

Codecov Report

Merging #633 (23d8c1f) into master (b13c582) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #633   +/-   ##
=======================================
  Coverage   80.71%   80.71%           
=======================================
  Files         240      240           
  Lines       17104    17104           
=======================================
  Hits        13806    13806           
  Misses       3298     3298           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b13c582...23d8c1f. Read the comment docs.

docs/outline.md Outdated
@@ -0,0 +1,59 @@
- [0. Overview](#0-overview)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a line at the top saying this is a work in progress (since many sections here would be empty)

docs/outline.md Outdated
- [Named Entity Recognition](#named-entity-recognition)
- [Relation Extraction](#relation-extraction)
- [Indexing](#indexing)
- [Ranking](#ranking)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indexing and ranking are information retrieval

docs/outline.md Outdated
- [3. Text Generation](#3-text-generation)
- [4. Question Answering System](#4-question-answering-system)
- [5. Chatbot](#5-chatbot)
- [7. More data format](#7-more-data-format)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using tasks (e.g. ASR)

docs/outline.md Outdated
- [1. Handling Structured Text Data](#1-handling-structured-text-data)
- [2. Processing Raw Text](#2-processing-raw-text)
- [Reader](#reader)
- [Tokenizer](#tokenizer)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tokenization, to be fair, is a task by itself.

@hepengfe hepengfe marked this pull request as ready for review February 10, 2022 17:41
@hepengfe hepengfe merged commit d3083be into asyml:master Feb 10, 2022
@hepengfe hepengfe deleted the doc_indexing branch February 10, 2022 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants