Skip to content
This repository was archived by the owner on Nov 22, 2022. It is now read-only.

Model export doc #148

Closed
wants to merge 5 commits into from
Closed

Model export doc #148

wants to merge 5 commits into from

Conversation

snisarg
Copy link
Contributor

@snisarg snisarg commented Dec 22, 2018

Motivation and Context

The documentation for testing a model currently uses the ATIS tutorial. Most users, coming to this page after the DocNN tutorial are thrown off by the changes in the expected output.

This change should simplify this.

How Has This Been Tested

See the new resultant docs here: https://731-143080897-gh.circle-artifacts.com/0/docs/execute_your_first_model.html

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Since this follows immediately after the train tutorial using DocNN, many readers are confused about the outputs seen current on this page as they're expecting to use DocNN, not ATIS that's shown here. We're updating this tutorial to reflect DocNN instead. Although poor in results, the assumption is that someone running ATIS would be better equipped at this stage to understand the results of the test step than a beginner just trying out train and test with PyText.
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Dec 22, 2018
Copy link
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@snisarg has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Contributor

@snisarg has updated the pull request. Re-import the pull request

Copy link
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@snisarg has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@snisarg snisarg deleted the model_export_doc branch December 27, 2018 01:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants