docs: Readme documentation for the laser_encoder package #246
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
facebook-github-bot
added
the
CLA Signed
heffernankevin
requested changes
Aug 23, 2023
… of __main__.py file
heffernankevin
approved these changes
Aug 29, 2023
| @@ -7,7 +7,7 @@ name = "laser_encoders" | |||
| version = "0.0.1" | |||
| authors = [{name = "Facebook AI Research"}] | |||
| description = "LASER Language-Agnostic SEntence Representations is a toolkit to calculate multilingual sentence embeddings and to use them for document classification, bitext filtering and mining" | |||
| readme = "README.md" | |||
| readme = "laser_encoders/README.md" | |||
There was a problem hiding this comment.
Is it necessary to prefix with laser_encoders?
There was a problem hiding this comment.
Yea, Still because of testpypi. If you don't point to it, it would use the README of the main laser repo which doesn't contain any information on how to run the laser package
There was a problem hiding this comment.
Do we not want the pyproject.toml file to live inside laser_encoders?
There was a problem hiding this comment.
Well I can't say for sure, you guys get to decide that. I worked based on the present structure. But my own suggestion too would be to move the pyproject.toml file
There was a problem hiding this comment.
Let's move it into laser_encoders
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.
This commit adds comprehensive README documentation for the laser_encoders Python package. The README provides clear instructions on installation, primary usage, contributing guidelines, licensing information, etc.