Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #85

Merged
merged 10 commits into from
Dec 16, 2024
Merged

Update documentation #85

merged 10 commits into from
Dec 16, 2024

Conversation

Waino
Copy link
Collaborator

@Waino Waino commented Dec 2, 2024

  • A new quickstart
  • Two new config_config templates, both used in the quickstart.
  • Update and expand the reference documentation for the config_config tool

@Waino Waino added the documentation Improvements or additions to documentation label Dec 2, 2024
@Waino Waino requested a review from jrvc December 2, 2024 12:40
@Waino
Copy link
Collaborator Author

Waino commented Dec 2, 2024

Note that this documentation assumes that PRs #83 and #84 are merged.

@Waino Waino force-pushed the chore/update-documentation branch from 41d1573 to d32140e Compare December 9, 2024 10:54
@Waino Waino requested a review from TimotheeMickus December 9, 2024 12:19
Copy link
Collaborator

@TimotheeMickus TimotheeMickus left a comment

Choose a reason for hiding this comment

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

mostly LGTM, but let's wait for @jrvc's perpsective before merging


Path templates for validation sets.
The path templates can contain the same variables as `src_path` and `tgt_path`.

Copy link
Collaborator

Choose a reason for hiding this comment

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

add example directory structure that would make this work


model_dim: 512
```bash
python ${MAMMOTH_DIR}/tools/config_config.py \
Copy link
Collaborator

Choose a reason for hiding this comment

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

mammoth bin instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed in #86


# INPUT/OUTPUT VOCABULARY CONFIG
```bash
python ${MAMMOTH_DIR}/tools/generate_synth_data.py \
Copy link
Collaborator

Choose a reason for hiding this comment

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

is this part of standard tools? if yes, why do require git cloning ; if no, can't we just suggesting wgetting?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed in #86

(this should only take a few seconds)

```bash
python ${MAMMOTH_DIR}/tools/config_config.py \
Copy link
Collaborator

Choose a reason for hiding this comment

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

use mammoth tool

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed in #86

Three scripts formerly in the tools directory have been promoted to
mammoth.bin and made into installable scripts.
- mammoth_config_config: Your trusted config swiss army knife.
- mammoth_iterate_tasks: Helper for iterating over all tasks in a
  config.
- mammoth_generate_synth_data: Toy data used in quickstart.
@Waino
Copy link
Collaborator Author

Waino commented Dec 16, 2024

2 weeks have passed with no objection. I'll go ahead and merge.

@Waino Waino merged commit 1d0a925 into main Dec 16, 2024
2 checks passed
@Waino Waino deleted the chore/update-documentation branch December 16, 2024 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants