Clarify English pipeline execution and directory assumptions - #3
Open
Raja-89 wants to merge 1 commit into
Open
Conversation
Author
|
PR opened - awaiting review. |
Author
|
Hi! Thanks for maintaining this repository. While testing the English YouTube pipeline end-to-end as a new contributor, I ran into a few undocumented execution assumptions (working directory, required output folders, STDOUT behavior, platform differences). I’ve documented these here to make onboarding smoother. I also drafted a minimal reproducible run and a short list of common failure modes locally while testing the pipeline further. Happy to share or extend this if it would be useful for contributor onboarding. Thanks again for your time and feedback! |
This file contains hidden or 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
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.
Docs: Clarify usage instructions for English pipeline
Description
This PR updates the README to clarify execution details for the English YouTube
caption processing pipeline. It documents several assumptions that are currently
implicit in the workflow, including script execution location, output handling,
and expected directory structure.
Motivation and Context
While testing the English pipeline as a new contributor, I noticed a few execution
details that are not currently explicit in the documentation. In particular:
english/directory are expected to be run from that directory,rather than from the repository root.
redirection to create output files.
(e.g.
test_corpus/vtt,test_corpus/json,test_corpus/conll_input) that mustexist prior to running the scripts.
Documenting these assumptions should make initial setup and onboarding clearer
for new contributors, including those working on Windows who may need to create
directories manually.
🛠️ Changes
📂 Type of Change
✅ Checklist