From e6c1f51a1c1f923ee488a03c4899d40fac132c71 Mon Sep 17 00:00:00 2001 From: KevinMusgrave Date: Tue, 19 Dec 2023 13:55:32 -0500 Subject: [PATCH] Fix broken link to PyTorchTrial docs --- gan/cyclegan/README.md | 2 +- gan/cyclegan/cyclegan.py | 2 +- model_hub/huggingface/language-modeling/README.md | 6 +++--- model_hub/huggingface/multiple-choice/README.md | 2 +- model_hub/huggingface/question-answering/README.md | 4 ++-- model_hub/huggingface/text-classification/README.md | 4 ++-- model_hub/huggingface/token-classification/README.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/gan/cyclegan/README.md b/gan/cyclegan/README.md index 07bd4b0..59ea0c0 100644 --- a/gan/cyclegan/README.md +++ b/gan/cyclegan/README.md @@ -6,7 +6,7 @@ Determined implementation of [CycleGAN](https://github.com/eriklindernoren/PyTor - **determined_model_def.py** is the user model definition file for Determined-managed training. This file is ported from **cyclegan.py** to implement the - [Determined Pytorch API](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial). + [Determined Pytorch API](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial). - **const.yaml** is the user configuration for Determined-managed training. - **startup-hook.sh** is the startup bash script that is used for downloading and extracting the training data. diff --git a/gan/cyclegan/cyclegan.py b/gan/cyclegan/cyclegan.py index b08027e..28c07ca 100644 --- a/gan/cyclegan/cyclegan.py +++ b/gan/cyclegan/cyclegan.py @@ -1,6 +1,6 @@ """ This file is not used in the Determined-managed training. We port this file to use the -Determined Pytorch API (https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial). +Determined Pytorch API (https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial). """ import argparse import os diff --git a/model_hub/huggingface/language-modeling/README.md b/model_hub/huggingface/language-modeling/README.md index dc698d6..c5c59d2 100644 --- a/model_hub/huggingface/language-modeling/README.md +++ b/model_hub/huggingface/language-modeling/README.md @@ -4,9 +4,9 @@ The examples here mirror the [language-modeling examples](https://github.com/hug You can finetune GPT and GPT-2 with the causal language model (CLM); ALBERT, BERT, DistilBERT, and RoBERTa with the masked language model(MLM); and XLNet with the permutation language model (PLM). ## Files -* **clm_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for CLM. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). -* **mlm_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for MLM. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). -* **plm_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for PLM. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **clm_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for CLM. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **mlm_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for MLM. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **plm_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for PLM. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). ### Configuration Files * **clm_config.yaml**: Experiment configuration for finetuning on WikiText-2 with GPT2. diff --git a/model_hub/huggingface/multiple-choice/README.md b/model_hub/huggingface/multiple-choice/README.md index d818db8..aca32ba 100644 --- a/model_hub/huggingface/multiple-choice/README.md +++ b/model_hub/huggingface/multiple-choice/README.md @@ -2,7 +2,7 @@ This example mirrors the [multiple choice example](https://github.com/huggingface/transformers/tree/master/examples/pytorch/multiple-choice) from the original huggingface transformers repo for finetuning on the SWAG dataset. ## Files -* **swag_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for this example. A few class methods are overwritten and specialized for named-entity recognition but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **swag_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for this example. A few class methods are overwritten and specialized for named-entity recognition but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). * **data.py**: Modifies ``DataCollatorForMultipleChoice`` to work with PyTorchTrial. ### Configuration FIles diff --git a/model_hub/huggingface/question-answering/README.md b/model_hub/huggingface/question-answering/README.md index 760395f..7f38333 100644 --- a/model_hub/huggingface/question-answering/README.md +++ b/model_hub/huggingface/question-answering/README.md @@ -2,9 +2,9 @@ The examples here mirror the [question answering examples](https://github.com/huggingface/transformers/tree/master/examples/pytorch/question-answering) from the original huggingface transformers repo. ## Files -* **qa_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for question-answering on SQuAD. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **qa_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for question-answering on SQuAD. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). * **data.py**: data pre and post-processing for question answering. -* **qa_beam_search_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for question-answering with beam search. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **qa_beam_search_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for question-answering with beam search. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). * **data_beam_search.py**: data pre and post-processing for question answering with beam search. ### Configuration Files diff --git a/model_hub/huggingface/text-classification/README.md b/model_hub/huggingface/text-classification/README.md index 384f667..7b71312 100644 --- a/model_hub/huggingface/text-classification/README.md +++ b/model_hub/huggingface/text-classification/README.md @@ -4,7 +4,7 @@ The two examples here mirror the [text-classification examples](https://github.c ## GLUE Benchmark ### Files -* **glue_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for this example. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **glue_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for this example. A few class methods are overwritten and specialized for text classification but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). #### Configuration Files * **glue_config.yaml**: Experiment configuration for finetuning on GLUE datasets with Bert. @@ -32,7 +32,7 @@ Using the provided experiment config `glue_config.yaml` yields a Matthew's Corre ## XNLI Dataset ### Files -* **xnli_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for this example. A few class methods are overwritten and specialized for text classification on XNLI but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **xnli_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for this example. A few class methods are overwritten and specialized for text classification on XNLI but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). #### Configuration Files * **xnli_config.yaml**: Experiment configuration for finetuning on the XNLI dataset with Bert. diff --git a/model_hub/huggingface/token-classification/README.md b/model_hub/huggingface/token-classification/README.md index f53e53d..1396f90 100644 --- a/model_hub/huggingface/token-classification/README.md +++ b/model_hub/huggingface/token-classification/README.md @@ -2,7 +2,7 @@ This example mirrors the [token-classification example](https://github.com/huggingface/transformers/tree/master/examples/pytorch/token-classification) from the original huggingface transformers repo for named-entity recognition. ## Files -* **ner_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/reference/api/pytorch.html#pytorch-trial) for this example. A few class methods are overwritten and specialized for named-entity recognition but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). +* **ner_trial.py**: The [PyTorchTrial definition](https://docs.determined.ai/latest/model-dev-guide/api-guides/apis-howto/api-pytorch-ug.html#pytorch-trial) for this example. A few class methods are overwritten and specialized for named-entity recognition but otherwise the behavior is the same as the [BaseTransformerTrial class](../model_hub/transformers/_trial.py). * **ner_utils.py**: Utility functions for NER largely extracted from [run_ner.py](https://github.com/huggingface/transformers/tree/master/examples/pytorch/token-classification/run_ner.py) to separate example code from Determined code. ### Configuration Files