Create linkcheck.yml (#286)

.github/workflows/linkcheck.yml

@@ -0,0 +1,21 @@
+name: Check Markdown links
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-quiet-mode: 'yes'

README.md

@@ -36,7 +36,7 @@ limitations under the License.
 <h3> ML model optimization product to accelerate inference </h3>
 
 <p>
-    <a href="https://docs.neuralmagic.com/sparsify/">
+    <a href="https://docs.neuralmagic.com/archive/sparsify/">
         <img alt="Documentation" src="https://img.shields.io/badge/documentation-darkred?&style=for-the-badge&logo=read-the-docs" height=25>
     </a>
     <a href="https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ/">
@@ -383,7 +383,7 @@ Thank you in advance for your feedback and interest!
 
 ### Learning More
 
-- Documentation: [SparseML](https://docs.neuralmagic.com/sparseml/), [SparseZoo](https://docs.neuralmagic.com/sparsezoo/), [Sparsify](https://docs.neuralmagic.com/sparsify/), [DeepSparse](https://docs.neuralmagic.com/deepsparse/)
+- Documentation: [SparseML](https://docs.neuralmagic.com/sparseml/), [SparseZoo](https://docs.neuralmagic.com/sparsezoo/), [Sparsify](https://docs.neuralmagic.com/archive/sparsify/), [DeepSparse](https://docs.neuralmagic.com/deepsparse/)
 - Neural Magic: [Blog,](https://www.neuralmagic.com/blog/) [Resources](https://www.neuralmagic.com/resources/)
 
 ### Release History

docs/source/userguide/01-intro.md

@@ -47,4 +47,4 @@ Submit bugs and feature requests. Check existing issues to avoid duplication.
 ---
 **Next step...**
 
-Begin by [installing Sparsify.](https://docs.neuralmagic.com/sparsify/main/source/userguide/02-install-sparsify.html)
+Begin by [installing Sparsify.](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/02-install-sparsify.html)

docs/source/userguide/02-install-sparsify.md

@@ -51,4 +51,4 @@ An information <kbd><img src="images/image_2.jpg" alt="(i)" width="25" height="2
 ---
 **Next step...**
 
-Go deeper on details with the [Sparsify Overview](https://docs.neuralmagic.com/sparsify/main/source/userguide/03-sparsify-overview.html).
+Go deeper on details with the [Sparsify Overview](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/03-sparsify-overview.html).

docs/source/userguide/03-sparsify-overview.md

@@ -63,4 +63,4 @@ When a section is active, it changes color. For example:
 ---
 **Next step...**
 
-Begin by [analyzing](https://docs.neuralmagic.com/sparsify/source/userguide/04-analyze.html) your model.
+Begin by [analyzing](https://docs.neuralmagic.com/archive/sparsify/source/userguide/04-analyze.html) your model.

docs/source/userguide/04-analyze.md

@@ -62,12 +62,12 @@ If further instructions are needed, consult the [SparseML's documentation on Exp
 
     The project name is used throughout Sparsify as a reference to your model. For example, if you create multiple projects using the same model, unique project names will enable you to differentiate.
 
-    **Note:** You can change the project name at any time by returning to this dialog or by changing the name in the [Settings](https://docs.neuralmagic.com/sparsify/main/source/userguide/07-settings.html).
+    **Note:** You can change the project name at any time by returning to this dialog or by changing the name in the [Settings](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/07-settings.html).
 
     <kbd><img src="images/image_10.jpg" alt="(Project name and description)" width="300" height="240" /></kbd>
 
     **Note:** Click BACK if you want to return to the previous dialog.
 
 5. Click **NEXT**.
 
-6. Continue by [Profiling Your Model](https://docs.neuralmagic.com/sparsify/main/source/userguide/04a-profiling-your-model.html).
+6. Continue by [Profiling Your Model](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/04a-profiling-your-model.html).

docs/source/userguide/04a-profiling-your-model.md

@@ -30,7 +30,7 @@ Profiling is used to determine how optimization will affect performance and loss
 
     You may opt to disable the Performance option if the model is large and will require numerous executions that will take considerable time. In this case, the performance profile will be approximated from the architecture as a FLOPS (floating point operations per second) profile. A FLOPS profile is a theoretical measure of performance.
 
-    If you are just [benchmarking](https://docs.neuralmagic.com/sparsify/main/source/userguide/05a-benchmark.html) the model, you may disable both the Performance and Loss options. In this case, both profiles will be approximated from the architecture.
+    If you are just [benchmarking](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/05a-benchmark.html) the model, you may disable both the Performance and Loss options. In this case, both profiles will be approximated from the architecture.
 
 2. Enter names for the performance and loss profiles. These names will be referenced throughout Sparsify to quickly identify your profiles.
 
@@ -42,7 +42,7 @@ Profiling is used to determine how optimization will affect performance and loss
 
     You should enter the batch size and core count to which you will deploy. Sparsify will run with this batch size and core count and apply the optimizations to the model to see how the performance is being changed. Batch size and core count can affect how Sparsify runs the model and how fast it is run; therefore, they affect how Sparsify optimizes the model.
 
-    **Note:** Eventually, you might want to run multiple performance profiles by [Adding a New Performance Profile](https://docs.neuralmagic.com/sparsify/main/source/userguide/04b-reviewing-performance-profiles.html#adding-a-new-performance-profile). For example, if you are unsure of how you will deploy, you might want to consider various optimization schemes. Or, you may want multiple performance profiles because you deploy a model in multiple ways (such as a throughput offline and latency online).
+    **Note:** Eventually, you might want to run multiple performance profiles by [Adding a New Performance Profile](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/04b-reviewing-performance-profiles.html#adding-a-new-performance-profile). For example, if you are unsure of how you will deploy, you might want to consider various optimization schemes. Or, you may want multiple performance profiles because you deploy a model in multiple ways (such as a throughput offline and latency online).
 
 4. Click **RUN** and a message will indicate that the system is profiling the performance and/or loss.
 
@@ -52,10 +52,10 @@ Profiling is used to determine how optimization will affect performance and loss
 
     <kbd><img src="images/image_13.jpg" alt="(Setup grayed out and option to click complete)" width="300" height="240" /></kbd>
 
-5. Click **COMPLETE**. The performance profile will be displayed, as described in [Reviewing Performance Profiles](https://docs.neuralmagic.com/sparsify/main/source/userguide/04b-reviewing-performance-profiles.html).
+5. Click **COMPLETE**. The performance profile will be displayed, as described in [Reviewing Performance Profiles](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/04b-reviewing-performance-profiles.html).
 
 ---
 **Next steps...**
 
-Continue by reviewing your [Performance Profiles](https://docs.neuralmagic.com/sparsify/main/source/userguide/04b-reviewing-performance-profiles.html) and [Loss Profiles](https://docs.neuralmagic.com/sparsify/main/source/userguide/04c-reviewing-loss-profiles.html).
-Then, you will be ready to [Optimize](https://docs.neuralmagic.com/sparsify/main/source/userguide/05-optimize.html).
+Continue by reviewing your [Performance Profiles](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/04b-reviewing-performance-profiles.html) and [Loss Profiles](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/04c-reviewing-loss-profiles.html).
+Then, you will be ready to [Optimize](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/05-optimize.html).

docs/source/userguide/04b-reviewing-performance-profiles.md

@@ -95,5 +95,5 @@ You can identify a new performance profile:
 ---
 **Next steps...**
 
-Continue by reviewing your [Loss Profiles](https://docs.neuralmagic.com/sparsify/main/source/userguide/04c-reviewing-loss-profiles.html).
-Then, you will be ready to [Optimize](https://docs.neuralmagic.com/sparsify/main/source/userguide/05-optimize.html).
+Continue by reviewing your [Loss Profiles](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/04c-reviewing-loss-profiles.html).
+Then, you will be ready to [Optimize](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/05-optimize.html).

docs/source/userguide/04c-reviewing-loss-profiles.md

@@ -81,5 +81,5 @@ You can identify a new loss profile:
 ---
 **Next steps...**
 
-Continue by reviewing your [Performance Profiles](https://docs.neuralmagic.com/sparsify/main/source/userguide/04b-reviewing-performance-profiles.html) if you have not already done so.
-Then, you will be ready to [Optimize](https://docs.neuralmagic.com/sparsify/main/source/userguide/05-optimize.html).
+Continue by reviewing your [Performance Profiles](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/04b-reviewing-performance-profiles.html) if you have not already done so.
+Then, you will be ready to [Optimize](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/05-optimize.html).

docs/source/userguide/05-optimize.md

@@ -58,7 +58,7 @@ To run Sparsify for optimization:
 
 3. Click **APPLY**.
 
-    **Note:** If you need to change these settings in the future, you can do so by changing the [Settings](https://docs.neuralmagic.com/sparsify/main/source/userguide/07-settings.html). However, changing these values later will not change the modifiers on the Optimization screen.
+    **Note:** If you need to change these settings in the future, you can do so by changing the [Settings](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/07-settings.html). However, changing these values later will not change the modifiers on the Optimization screen.
 
 The Optimization screen is displayed. For example:
 
@@ -160,10 +160,10 @@ The training summary lays out all of the modifiers that are running and when tho
 
 ## Exporting
 
-When you are satisfied with the optimization setting, click the **EXPORT** button to export a configuration file and integrate code into your training, as described in the [Integrate](https://docs.neuralmagic.com/sparsify/main/source/userguide/06-integrate.html) section.
+When you are satisfied with the optimization setting, click the **EXPORT** button to export a configuration file and integrate code into your training, as described in the [Integrate](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/06-integrate.html) section.
 
 ---
 **Next steps...**
 
-Continue by [Benchmarking](https://docs.neuralmagic.com/sparsify/main/source/userguide/05a-benchmark.html).
-Otherwise, you are ready to [Integrate](https://docs.neuralmagic.com/sparsify/main/source/userguide/06-integrate.html).
+Continue by [Benchmarking](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/05a-benchmark.html).
+Otherwise, you are ready to [Integrate](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/06-integrate.html).

docs/source/userguide/05a-benchmark.md

@@ -99,4 +99,4 @@ Click the <kbd><img src="images/image_58.jpg" alt="(Menu icon)" width="4" height
 ---
 **Next step...**
 
-Depending on the results of your benchmarks, you may want to [Optimize](https://docs.neuralmagic.com/sparsify/main/source/userguide/05-optimize.html) again or [Integrate](https://docs.neuralmagic.com/sparsify/main/source/userguide/06-integrate.html).
+Depending on the results of your benchmarks, you may want to [Optimize](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/05-optimize.html) again or [Integrate](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/06-integrate.html).

docs/source/userguide/06-integrate.md

@@ -35,4 +35,4 @@ You can choose the PyTorch or TensorFlow framework, and the file code will chang
 ---
 **Next step...**
 
-Explore the [Optimization Config File and Code for Optimization](https://docs.neuralmagic.com/sparsify/main/source/userguide/06a-optimize-config.html).
+Explore the [Optimization Config File and Code for Optimization](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/06a-optimize-config.html).

docs/source/userguide/06a-optimize-config.md

@@ -31,4 +31,4 @@ After exporting, you would integrate the configuration file into your training f
 ---
 **Next step...**
 
-Explore your project's [Settings](https://docs.neuralmagic.com/sparsify/main/source/userguide/07-settings.html) or review general [Key Concepts, Features, and Terms](https://docs.neuralmagic.com/sparsify/main/source/userguide/08-key-terms.html) mentioned throughout Sparsify.
+Explore your project's [Settings](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/07-settings.html) or review general [Key Concepts, Features, and Terms](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/08-key-terms.html) mentioned throughout Sparsify.

docs/source/userguide/07-settings.md

@@ -33,4 +33,4 @@ Settings for a saved project can be accessed from your project's left navigation
 ---
 **Next step...**
 
-Review general [Key Concepts, Features, and Terms](https://docs.neuralmagic.com/sparsify/main/source/userguide/08-key-terms.html) mentioned throughout Sparsify.
+Review general [Key Concepts, Features, and Terms](https://docs.neuralmagic.com/archive/sparsify/main/source/userguide/08-key-terms.html) mentioned throughout Sparsify.

docs/sparse-transfer-experiment-guide.md

@@ -47,7 +47,7 @@ To utilize the cloud pathways for Sparse-Transfer Experiments, review the [Cloud
 Now that you understand what a Sparse-Transfer Experiment is and the benefits, including fine-tuning a pre-optimized, sparse model on your data, you're ready to use the CLI to effectively run a Sparse-Transfer Experiment. 
 
 Before you run a Sparse-Transfer Experiment, confirm you are logged into the Sparsify CLI. 
-For instructions on Installation and Setup, review the [Sparsify Install and Setup Section](READMEsection.com) in the Sparsify README. 
+For instructions on Installation and Setup, review the [Sparsify Install and Setup Section](https://github.com/neuralmagic/sparsify#1-install-and-setup) in the Sparsify README. 
 
 Sparse-Transfer Experiments use the following general command:
 
@@ -89,16 +89,16 @@ Confirm that your data is formatted properly according to the standards listed b
 Different use cases may require different input formats depending on what is considered standard for that use case.
 Specifically, the following are the supported formats as well as links to specs and guides for creating datasets for each format:
 - `cv-classification`: Image Folder Format
-  - [Image Classification Dataset Guide](./datasets-guide#image-classification)
+  - [Image Classification Dataset Guide](./datasets-guide.md#image-classification)
   - Example structure: data/{SPLIT}/{CLASS}/{IMAGE.EXT})
 - `cv-detection` - YOLO Format 
-  - [Object Detection Dataset Guide](./datasets-guide#object-detection)
+  - [Object Detection Dataset Guide](./datasets-guide.md#object-detection)
   - Example structure: data/classes.txt; data/images/{SPLIT}/{IMAGE.EXT}; data/labels/{SPLIT}/{IMAGE.EXT})
 - `cv-segmentation` - YOLO Format
-  - [Image Segmentation Dataset Guide](./datasets-guide#image-segmentation)
+  - [Image Segmentation Dataset Guide](./datasets-guide.md#image-segmentation)
   - Example structure: data/classes.txt; data/images/{SPLIT}/{IMAGE.EXT}; data/annotations/{SPLIT}/{IMAGE.EXT})
 - `nlp-*`: Hugging Face CSV or JSONW Format
-  - [NLP Dataset Guide](./datasets-guide#nlp)
+  - [NLP Dataset Guide](./datasets-guide.md#nlp)
   - Example structure: data/{SPLIT}.csv or data/{SPLIT}.jsonl or data/{SPLIT}.json
 
 Currently, custom use cases are not supported for dataset representation and datasets must conform to the definitions above. 
@@ -130,14 +130,14 @@ If no model is provided, the best pre-sparsified model and recipe from the Spars
 
 If you choose to override the model, it is expected to be a pre-sparsified model and adhere to the following formats depending on the use case:
 - `cv-classification`: SparseML PTH Format
-  - [Image Classification Models Guide](./models-guide#image-classification)
+  - [Image Classification Models Guide](./models-guide.md#image-classification)
 - `cv-detection` - YOLOv5/YOLOv8 Format 
-  - [Object Detection Models Guide](./models-guide#object-detection)
+  - [Object Detection Models Guide](./models-guide.md#object-detection)
   - Example structure: data/classes.txt; data/images/{SPLIT}/{IMAGE.EXT}; data/labels/{SPLIT}/{IMAGE.EXT})
 - `cv-segmentation` - YOLOv5/YOLOv8 Format
-  - [Image Segmentation Models Guide](./models-guide#image-segmentation)
+  - [Image Segmentation Models Guide](./models-guide.md#image-segmentation)
 - `nlp-*`: Hugging Face Format
-  - [NLP Models Guide](./models-guide#nlp)
+  - [NLP Models Guide](./models-guide.md#nlp)
 
 Currently, custom use cases are not supported for model representation and models must conform to the definitions above.
 In the near future, these will be supported through plugin specifications.