Initial Commit for Vidyut-Chandas #82
Closed
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
Added initial JSON data files and implemented serde for parsing. Introduced basic structs for Aksharas, Input, etc. Minimal structs for matching because I didn't know how to proceed. Think it's a good starting point overall. Probably code organisation is bad (pub vs private methods/structs)....
|
LGTM |
Reusing old code.
Rustfmt giving weird error and refusing to format when the keyword 'crate' is used.
…ad of doing .chars().nth() each time. Not sure about whether I am handling the last syllable properly.
Implemented the correct to_aksharas function which groups the characters and also finds the G-L scheme.
|
Thank you very much for your PR! Forgive my very delayed response. I've made a few changes on top of this PR, but I want to make a few more before merging so that we have a clean end-to-end API. I tried pushing on top of this branch but wasn't able to some for reason. Instead, you can find my changes here. Briefly, my changes include:
I'll continue on this branch for a bit before merging, with a goal of having a simple frontend as well. |
|
I am going ahead and closing this pull request then. |
akprasad
added a commit
that referenced
this pull request
Jan 1, 2024
This commit adds a basic implementation of `vidyut-chandas` along with some starter documentation. `vidyut-chandas` is pre-alpha code that I'm shipping as a scaffold for future work. Currently, `vidyut-chandas` supports a variety of vrtta meters, but it has no support for jAti meters, which is the next major feature to implement. Our documentation is also lacking, but it's a promising start. This commit was prepared primarily by me but with major contributions from Pradyumna Malladi (@MSSRPRAD), who created a [first draft][1] of the code based on a design document we collaborated on [here][2]. My contributions were: - some cleanup to the input data format to use simple TSVs instead of JSON files with serde. We currently have a serde dependency to support our frontend, but this is not a core part of the crate and can be removed in a future refactor. - some simplification to the API, particularly the use of a single `name` instead of `names` for each meter and the avoidance of some intermediate structs during serde - the `classify` method and its matching logic - some tweaks to our logic for calculating meter ganas - most of the documentation, including the README, docstrings, and sample code - most unit tests, especially for classifying different meters - our WebAssembly bindings and frontend Pradyuma's contributions were: - a partial first draft of an end-to-end solution, including the basic data model for meters and aksharas - data management, including sourcing our original meters file and writing the logic to read this file into our data structures - a first draft of logic to calculate meter ganas - a partial port of some of Vidyut's utility functions for testing Sanskrit sounds - suggestions to make the returned matching object richer in order to support future ranking use-cases All errors in recollection are my own. [1]: #82 [2]: https://paper.dropbox.com/doc/Metrical-recognizer-API-v0--CCgFzji5rgBZYEMJkWAt_j5bAg-pZGhBvlQQBFcPx7SeWSE9 Co-authored-by: Pradyumna Malladi <[email protected]>
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.
Added JSON data files and the code to parse them using serde. Added basic structs for Aksharas, Input, etc. Minimal structs for matching because I didn't know how to proceed.
Think it's a good starting point overall. Probably code organisation is bad (overusing
pubfor example)....