Add Documentation for FORA, NPR-2p, and FOMC Corpus and Update Related Datasets and Config Files #238
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
change what is needed
- Included conversion notebook and rst file for DeliData - Reworked convokit to properly load both
Fixed Usage to include load_corpus
Included delidata download link
Fixed unintended changes
|
@all-contributors please add @yash-chatha for Documentation, Examples |
|
I've put up a pull request to add @yash-chatha! 🎉 |
|
@all-contributors please add @laerdon for Documentation, Examples |
|
I've put up a pull request to add @laerdon! 🎉 |
|
@all-contributors please add @laerdon for Documentation, Examples |
|
I've put up a pull request to add @laerdon! 🎉 |
|
@all-contributors please add @yash-chatha for Documentation, Examples |
|
I've put up a pull request to add @yash-chatha! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I added the fora.rst file with detailed documentation for the FORA Corpus, ensuring that it is properly reflected in the ConvoKit website. In addition, I updated the datasets.rst file to include the FORA dataset, and made necessary changes to the download_config.json file to ensure the correct handling and downloading of the dataset. I did the same for the NPR-2p and FOMC corpuses. All files now should have working links to their respective conversion notebooks.
Motivation and Context
This change is required to integrate the new FORA Corpus into the ConvoKit website's documentation and ensure that it can be downloaded and utilized by users, as well as adding the NPR-2p and FOMC corpuses from the previous PR. This update solves the problem of incomplete dataset documentation and configuration by ensuring that the new corpus is fully supported.
How has this been tested?
These changes were tested by verifying that the documentation renders correctly in the local development environment and by confirming that the updates to the configuration file allow for successful dataset download. I ran tests locally to ensure that these changes did not interfere with existing functionality. I also verified through the index.html files reflected all changes as expected.
Other information
N/A