asyml / asyml/forte

Create tutorial for the system.

Open
#33 0 comments 0 reactions 0 assignees View on GitHub
priority: medium topic: docs
Dominant language
Python
Stars
253
Forks
59
PR merge metrics
No merged PRs in 30d

Description

There are a few important tutorials, which should be written as notebooks, let's do them in this order:

1. Construct pipeline (with code and with config, use existing processor as examples)
1. Write a reader
1. Write a pack processor
1. Understand ontology (using ontology generator)
1. Write a batch pack processor (batch processor and batcher)
1. Write a trainer
1. Build a training pipeline (preprocess, resources and executor)
1. Model reuse
1. Construct pipelines with Multipacks (multipack processor, selector)
1. Understand Information Retrieval pipeline

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing processor examples and the notebook approach, then trace the mentioned ontology generator, batch processor and batcher, preprocessing, resources and executor, multipack processor and selector. Done means adding notebooks that cover the tutorials in the listed order, including code and configuration examples where requested.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.