Link to documentation within text tutorials #1190

sarahyurick · 2025-10-20T22:38:42Z

Closes #1095.

Signed-off-by: Sarah Yurick <[email protected]>

copy-pr-bot · 2025-10-20T22:38:45Z

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

Signed-off-by: Sarah Yurick <[email protected]>

greptile-apps

_{15 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

lbliii

LGTM.

Minor nit: remove "please" throughout. Typically we reserve please for scenarios where there's a known bug and a very inconvenient workaround they must use.

sarahyurick · 2025-10-22T15:53:49Z

@lbliii thanks, I will modify.

sarahyurick

Adding suggestions for nits...

tutorials/text/deduplication/semantic/semantic_e2e.ipynb

tutorials/text/deduplication/semantic/semantic_step_by_step.ipynb

sarahyurick · 2025-10-22T16:12:39Z

tutorials/text/distributed-data-classification/quality-classification.ipynb

    "  - CUDA 12.x\n",
    "\n",
-    "Before running this notebook, please see this [Installation Guide](https://docs.nvidia.com/nemo/curator/latest/admin/installation.html#admin-installation) page for instructions on how to install NeMo Curator. Be sure to use an installation method which includes GPU dependencies."
+    "Before running this notebook, please see this [Installation Guide](https://docs.nvidia.com/nemo/curator/latest/admin/installation.html#admin-installation) page for instructions on how to install NeMo Curator. Be sure to use an installation method which includes GPU dependencies.\n",


Suggested change

"Before running this notebook, please see this [Installation Guide](https://docs.nvidia.com/nemo/curator/latest/admin/installation.html#admin-installation) page for instructions on how to install NeMo Curator. Be sure to use an installation method which includes GPU dependencies.\n",

"Before running this notebook, see this [Installation Guide](https://docs.nvidia.com/nemo/curator/latest/admin/installation.html#admin-installation) page for instructions on how to install NeMo Curator. Be sure to use an installation method which includes GPU dependencies.\n",

sarahyurick · 2025-10-22T16:13:00Z

tutorials/text/distributed-data-classification/quality-classification.ipynb

-    "Before running this notebook, please see this [Installation Guide](https://docs.nvidia.com/nemo/curator/latest/admin/installation.html#admin-installation) page for instructions on how to install NeMo Curator. Be sure to use an installation method which includes GPU dependencies."
+    "Before running this notebook, please see this [Installation Guide](https://docs.nvidia.com/nemo/curator/latest/admin/installation.html#admin-installation) page for instructions on how to install NeMo Curator. Be sure to use an installation method which includes GPU dependencies.\n",
+    "\n",
+    "For more information about the classifiers, please refer to our [Distributed Data Classification](https://docs.nvidia.com/nemo/curator/latest/curate-text/process-data/quality-assessment/distributed-classifier.html) documentation page. Please refer to the [Classifier-Based Filtering](https://docs.nvidia.com/nemo/curator/latest/curate-text/process-data/quality-assessment/classifier.html) page for more information about quality classification in NeMo Curator."


Suggested change

"For more information about the classifiers, please refer to our [Distributed Data Classification](https://docs.nvidia.com/nemo/curator/latest/curate-text/process-data/quality-assessment/distributed-classifier.html) documentation page. Please refer to the [Classifier-Based Filtering](https://docs.nvidia.com/nemo/curator/latest/curate-text/process-data/quality-assessment/classifier.html) page for more information about quality classification in NeMo Curator."

"For more information about the classifiers, refer to our [Distributed Data Classification](https://docs.nvidia.com/nemo/curator/latest/curate-text/process-data/quality-assessment/distributed-classifier.html) documentation page. Refer to the [Classifier-Based Filtering](https://docs.nvidia.com/nemo/curator/latest/curate-text/process-data/quality-assessment/classifier.html) page for more information about quality classification in NeMo Curator."

sarahyurick · 2025-10-22T16:13:10Z

tutorials/text/distributed-data-classification/quality-classification.ipynb

-    "```"
+    "```\n",
+    "\n",
+    "Please refer to the [API Reference](https://docs.nvidia.com/nemo/curator/latest/apidocs/stages/stages.text.classifiers.quality.html#stages.text.classifiers.quality.QualityClassifier) for more information about the `QualityClassifier` class."


Suggested change

"Please refer to the [API Reference](https://docs.nvidia.com/nemo/curator/latest/apidocs/stages/stages.text.classifiers.quality.html#stages.text.classifiers.quality.QualityClassifier) for more information about the `QualityClassifier` class."

"See the [API Reference](https://docs.nvidia.com/nemo/curator/latest/apidocs/stages/stages.text.classifiers.quality.html#stages.text.classifiers.quality.QualityClassifier) for more information about the `QualityClassifier` class."

sarahyurick · 2025-10-22T16:13:23Z

tutorials/text/download-and-extract/README.md


 This Jupyter notebook tutorial demonstrates how to use NeMo Curator to download text data from [Common Crawl](https://commoncrawl.org/), [Wikipedia](https://dumps.wikimedia.org/backup-index.html), and [ArXiv](https://info.arxiv.org/help/bulk_data_s3.html), respectively.

+For more information about downloading and extracting data with NeMo Curator, please refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages.


Suggested change

For more information about downloading and extracting data with NeMo Curator, please refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages.

For more information about downloading and extracting data with NeMo Curator, refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages.

sarahyurick · 2025-10-22T16:13:37Z

tutorials/text/download-and-extract/download_extract_tutorial.ipynb

-    "NeMo Curator has pre-built download and extract pipelines for **Common Crawl**, **Wikipedia** and **ArXiv** datasets. In this tutorial, we will introduce how to execute these pipelines."
+    "NeMo Curator has pre-built download and extract pipelines for **Common Crawl**, **Wikipedia** and **ArXiv** datasets. In this tutorial, we will introduce how to execute these pipelines.\n",
+    "\n",
+    "For more information about downloading and extracting data with NeMo Curator, please refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages."


Suggested change

"For more information about downloading and extracting data with NeMo Curator, please refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages."

"For more information about downloading and extracting data with NeMo Curator, refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages."

sarahyurick

Adding suggestions for nits...

tutorials/text/distributed-data-classification/README.md

Signed-off-by: Sarah Yurick <[email protected]>

* link to docs in classifier tutorials Signed-off-by: Sarah Yurick <[email protected]> * add links to semdedup tutorials Signed-off-by: Sarah Yurick <[email protected]> * download and extract links Signed-off-by: Sarah Yurick <[email protected]> * Apply suggestions from code review Signed-off-by: Sarah Yurick <[email protected]> --------- Signed-off-by: Sarah Yurick <[email protected]> Signed-off-by: Sarah Yurick <[email protected]> Signed-off-by: Lawrence Lane <[email protected]>

* link to docs in classifier tutorials Signed-off-by: Sarah Yurick <[email protected]> * add links to semdedup tutorials Signed-off-by: Sarah Yurick <[email protected]> * download and extract links Signed-off-by: Sarah Yurick <[email protected]> * Apply suggestions from code review Signed-off-by: Sarah Yurick <[email protected]> --------- Signed-off-by: Sarah Yurick <[email protected]> Signed-off-by: Sarah Yurick <[email protected]>

link to docs in classifier tutorials

7efa592

Signed-off-by: Sarah Yurick <[email protected]>

sarahyurick added the documentation Improvements or additions to documentation label Oct 20, 2025

sarahyurick added 2 commits October 20, 2025 15:53

add links to semdedup tutorials

3ec67a3

Signed-off-by: Sarah Yurick <[email protected]>

download and extract links

f59b7de

Signed-off-by: Sarah Yurick <[email protected]>

sarahyurick marked this pull request as ready for review October 20, 2025 23:07

sarahyurick requested a review from lbliii October 20, 2025 23:07

greptile-apps bot reviewed Oct 20, 2025

View reviewed changes

sarahyurick requested a review from arhamm1 October 21, 2025 16:59

Merge branch 'main' into text_tutorial_links

6dd4b3c

arhamm1 approved these changes Oct 22, 2025

View reviewed changes

Merge branch 'main' into text_tutorial_links

bc287d0

lbliii approved these changes Oct 22, 2025

View reviewed changes

sarahyurick commented Oct 22, 2025

View reviewed changes

tutorials/text/distributed-data-classification/README.md Outdated Show resolved Hide resolved

Apply suggestions from code review

cdda6b8

Signed-off-by: Sarah Yurick <[email protected]>

sarahyurick merged commit 6697e59 into NVIDIA-NeMo:main Oct 22, 2025
11 checks passed

sarahyurick deleted the text_tutorial_links branch February 9, 2026 18:14

	"Before running this notebook, please see this [Installation Guide](https://docs.nvidia.com/nemo/curator/latest/admin/installation.html#admin-installation) page for instructions on how to install NeMo Curator. Be sure to use an installation method which includes GPU dependencies.\n",
	"Before running this notebook, see this [Installation Guide](https://docs.nvidia.com/nemo/curator/latest/admin/installation.html#admin-installation) page for instructions on how to install NeMo Curator. Be sure to use an installation method which includes GPU dependencies.\n",

	"Please refer to the [API Reference](https://docs.nvidia.com/nemo/curator/latest/apidocs/stages/stages.text.classifiers.quality.html#stages.text.classifiers.quality.QualityClassifier) for more information about the `QualityClassifier` class."
	"See the [API Reference](https://docs.nvidia.com/nemo/curator/latest/apidocs/stages/stages.text.classifiers.quality.html#stages.text.classifiers.quality.QualityClassifier) for more information about the `QualityClassifier` class."


		This Jupyter notebook tutorial demonstrates how to use NeMo Curator to download text data from [Common Crawl](https://commoncrawl.org/), [Wikipedia](https://dumps.wikimedia.org/backup-index.html), and [ArXiv](https://info.arxiv.org/help/bulk_data_s3.html), respectively.

		For more information about downloading and extracting data with NeMo Curator, please refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages.

	"For more information about downloading and extracting data with NeMo Curator, please refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages."
	"For more information about downloading and extracting data with NeMo Curator, refer to the [Download Data](https://docs.nvidia.com/nemo/curator/latest/curate-text/load-data/index.html) and [Data Acquisition Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/text/data-acquisition-concepts.html) documentation pages."

Link to documentation within text tutorials #1190

Link to documentation within text tutorials #1190

Uh oh!

Conversation

sarahyurick commented Oct 20, 2025

Uh oh!

copy-pr-bot bot commented Oct 20, 2025

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

lbliii left a comment

Choose a reason for hiding this comment

Uh oh!

sarahyurick commented Oct 22, 2025

Uh oh!

sarahyurick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sarahyurick Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

sarahyurick Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

sarahyurick Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

sarahyurick Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

sarahyurick Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

sarahyurick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants