Skip to content

Commit

Permalink
Update docs (#235)
Browse files Browse the repository at this point in the history
* Add a blog for extracting customer reviews with NLP Lab

* restructure the blogs section

* updated menu and added a sample page for tutorials

* updated step-by-step tutorials page

* Update the docs with respect to 4.9 release notes

* remove changes made in tutorial branch

* rename #_posts folder

* Restore the project_creation file

---------

Co-authored-by: diatrambitas <JSL.Git2018>
  • Loading branch information
divyanshukatiyar committed May 24, 2023
1 parent 4b6881d commit 0a7c175
Show file tree
Hide file tree
Showing 24 changed files with 103 additions and 37 deletions.
48 changes: 22 additions & 26 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@ PATH
GEM
remote: https://rubygems.org/
specs:
activesupport (6.0.6)
activesupport (6.0.6.1)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
zeitwerk (~> 2.2, >= 2.2.2)
addressable (2.8.1)
addressable (2.8.4)
public_suffix (>= 2.0.2, < 6.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
colorator (1.1.0)
commonmarker (0.23.6)
concurrent-ruby (1.1.10)
dnsruby (1.61.9)
simpleidn (~> 0.1)
commonmarker (0.23.9)
concurrent-ruby (1.2.2)
dnsruby (1.70.0)
simpleidn (~> 0.2.1)
elasticsearch (7.17.7)
elasticsearch-api (= 7.17.7)
elasticsearch-transport (= 7.17.7)
Expand All @@ -35,12 +35,12 @@ GEM
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.15.0)
ethon (0.16.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
eventmachine (1.2.7-x64-mingw32)
eventmachine (1.2.7-x86-mingw32)
execjs (2.8.1)
faraday (1.10.2)
faraday (1.10.3)
faraday-em_http (~> 1.0)
faraday-em_synchrony (~> 1.0)
faraday-excon (~> 1.1)
Expand All @@ -63,9 +63,8 @@ GEM
faraday-patron (1.0.0)
faraday-rack (1.0.0)
faraday-retry (1.0.3)
ffi (1.15.5)
ffi (1.15.5-x64-mingw-ucrt)
ffi (1.15.5-x64-mingw32)
ffi (1.15.5-x86-mingw32)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (227)
Expand Down Expand Up @@ -238,28 +237,28 @@ GEM
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
mini_portile2 (2.8.0)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.16.3)
minitest (5.18.0)
multi_json (1.15.0)
multipart-post (2.2.3)
nokogiri (1.13.9)
mini_portile2 (~> 2.8.0)
multipart-post (2.3.0)
nokogiri (1.14.3-x64-mingw-ucrt)
racc (~> 1.4)
nokogiri (1.14.3-x86-mingw32)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.7)
racc (1.6.0)
racc (1.6.2)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
Expand All @@ -283,22 +282,19 @@ GEM
thread_safe (0.3.6)
typhoeus (1.4.0)
ethon (>= 0.9.0)
tzinfo (1.2.10)
tzinfo (1.2.11)
thread_safe (~> 0.1)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2)
unicode-display_width (1.8.0)
wdm (0.1.1)
webrick (1.7.0)
zeitwerk (2.6.1)
webrick (1.8.1)
zeitwerk (2.6.7)

PLATFORMS
x64-mingw-ucrt
x64-mingw32
x86_64-darwin-21
x86_64-darwin-22
x86_64-linux
x86-mingw32

DEPENDENCIES
elasticsearch (~> 7.10)
Expand All @@ -311,4 +307,4 @@ DEPENDENCIES
webrick

BUNDLED WITH
2.3.24
2.4.12
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/en/alab/annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ Dedicated action icons are available on the completions widgets to allow users t

<img class="image image__shadow" src="https://user-images.githubusercontent.com/45035063/204707502-acaba8b8-43d0-4354-8c14-4f66132131ad.png" style="width:100%;"/>

It is an important to ensure a complete audit trail of all user actions. Annotation Lab tracks the history and details of any deleted completions. It means it is possible to see the name of the completion creator, date of creation, and deletion.
It is an important to ensure a complete audit trail of all user actions. Annotation Lab tracks the history and details of any deleted completions. It means it is possible to see the name of the completion creator, date of creation, and deletion. As of version 4.9, the users can also view the "Lead Time" which is the time taken to annotate the completion, and "Edit Time" which is the time taken to make changes to the completion after creating a copy of the completion. By utilizing the "Versions" tab users can now track the source of a copied completion as well as the number of edits made between consecutive completions.

<img class="image image__shadow image__align--center" src="/assets/images/annotation_lab/4.1.0/completion_history.png" style="width:40%;"/>
<img class="image image__shadow image__align--center" src="/assets/images/annotation_lab/4.9.0/completion_history.png" style="width:40%;"/>

<br />

Expand Down
26 changes: 17 additions & 9 deletions docs/en/alab/productivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,19 @@ Below are the charts included in the Tasks section.

**Total vs distinct count of labels across all completions**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/total_vs_distinct_by_label_across_completions.png" style="width:100%;"/>
<img class="image image__shadow" src="/assets/images/annotation_lab/4.9.0/total_vs_distinct_values.png" style="width:100%;"/>

**Average number of tokens by label**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/average_number_of_tokens_by_label.png" style="width:100%;"/>

**Total number of label occurrences that include numeric values**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/numeric_values_across_labels.png" style="width:100%;"/>
<img class="image image__shadow" src="/assets/images/annotation_lab/4.9.0/numeric_values_across_labels.png" style="width:100%;"/>

**Average length of tasks completed by each Annotator**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.9.0/average_task_length.png" style="width:100%;"/>

<br />

Expand All @@ -92,25 +96,29 @@ To access Team Productivity charts, navigate on the second tab of the <es>Analyt

Below are the charts included in the Team Productivity section.

**Total number of completions in the Project**
<!-- **Total number of completions in the Project**
<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/total_completions.png" style="width:100%;"/>
**Total number of completions in the Project in the last 30 days**
<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/total_completions_in_last_30_days.png" style="width:100%;"/>
<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/total_completions_in_last_30_days.png" style="width:100%;"/> -->

**Visual Representation of the completions**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.9.0/team_productivity_analytics.png" style="width:100%;"/>

**Total number of completions for each Annotator**
**Total completions vs Ground Truth completions per Annotator**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/total_number_of_completions_per_annotator.png" style="width:100%;"/>
<img class="image image__shadow" src="/assets/images/annotation_lab/4.9.0/total_completions_vs_ground_truth.png" style="width:100%;"/>

**Total number of completions submitted over time for each Annotator**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/submitted_completions_over_time_per_annotator.png" style="width:100%;"/>

**Average time spent by the Annotator in each task**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/average_time_annotator_spent_on_one_task.png" style="width:100%;"/>
<img class="image image__shadow" src="/assets/images/annotation_lab/4.9.0/average_time_per_task.png" style="width:100%;"/>

**Total number of completions submitted over time**

Expand All @@ -122,7 +130,7 @@ Below are the charts included in the Team Productivity section.

Starting from version 2.8.0, Inter Annotator Agreement(IAA) charts allow the comparison between annotations produced by <es>Annotators</es>, <es>Reviewers</es>, or <es>Managers</es>.

<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/iaa_analytics.gif" style="width:100%;"/>
<img class="image image__shadow" src="/assets/images/annotation_lab/4.9.0/iaa_analytics.gif" style="width:100%;"/>

Inter Annotator Agreement charts can be used by <es>Annotators</es>, <es>Reviewers</es>, and <es>Managers</es> for identifying contradictions or disagreements within the starred completions (Ground Truth). When multiple annotators work on same tasks, IAA charts are handy to measure how well the annotations created by different annotators align. IAA chart can also be used to identify outliers in the labeled data, or to compare manual annotations with model predictions.

Expand All @@ -144,7 +152,7 @@ Below are the charts included in the Inter-Annotator Agreement section.

**Comparison of annotations by annotator on each chunk**

<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/analytics/annotators_comparison_by_chunk.png" style="width:100%;"/>
<img class="image image__shadow" src="/assets/images/annotation_lab/4.9.0/annotators_comparison_by_chunks.png" style="width:100%;"/>

**Comparison of annotations by model and annotator (Ground Truth) on each chunk**

Expand Down
62 changes: 62 additions & 0 deletions docs/en/alab/step_by_step_tutorials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
layout: docs
comment: no
header: true
seotitle: NLP Lab | John Snow Labs
title: Step by Step Tutorials
permalink: /docs/en/alab/step_by_step_tutorials
modify_date: "2023-05-01"
use_language_switcher: "Python-Scala"
show_nav: true
sidebar:
nav: annotation-lab
---

<div class="block-wrapper block-wrapper-top">


<a href="/docs/en/alab/NER_project_creation">
<div class="block-box" markdown="1">
<div class="has_i" markdown="1">
## 1. Get started with NER projects
</div>
- Create an NER project for text content
- Configure taxonomy
- Import tasks
</div>
</a>

<div class="block-box" markdown="1">
<div class="has_i" markdown="1">
## 2. Pre-annotations for text content
</div>

- Combine models, rules and prompts
- Pre-annotate tasks
- Correct pre-annotations
</div>

</div>

<div class="block-wrapper block-wrapper-top">
<div class="block-box" markdown="1">
<div class="has_i" markdown="1">
## 3. Text classification
</div>

- Create a text classification project
- Configure taxonomy
- Train
</div>

<div class="block-box" markdown="1">
<div class="has_i" markdown="1">
## 4. Experiments in the playground
</div>

-
-
-

</div>
</div>

0 comments on commit 0a7c175

Please sign in to comment.