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

Unify docs and convert rst to ipynb #1644

Merged
merged 25 commits into from
Oct 9, 2023
Merged

Unify docs and convert rst to ipynb #1644

merged 25 commits into from
Oct 9, 2023

Conversation

dmitrijeuseew
Copy link
Contributor

Write docs in unified format: 1. Introduction to the task. 2. Get started with the model. 3. Models list. 4. Use the model for prediction. 5. Customize the model.
Convert rst docs in ipynb format.

docs/index.rst Show resolved Hide resolved
@vaskonov vaskonov requested a review from IgnatovFedor October 2, 2023 16:15
@IgnatovFedor IgnatovFedor merged commit be82466 into dev Oct 9, 2023
@IgnatovFedor IgnatovFedor deleted the feat/unify_docs branch October 9, 2023 13:11
@IgnatovFedor IgnatovFedor mentioned this pull request Oct 11, 2023
Comment on lines +99 to +120
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"ranking([[\"Forrest Gump is a 1994 American epic comedy-drama film directed by Robert Zemeckis.\",\n",
" \"Robert Zemeckis directed Forrest Gump.\",\n",
" \"Robert Lee Zemeckis was born on May 14, 1952, in Chicago.\"]])"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"**Input:** List[List[sentence1, sentence2, ...]], where the sentences from the second to the last will be ranked by similarity with the first sentence.\n",
"\n",
"**Output:** List[List[scores]] - similarity scores to the first sentence of the sentences from the second to the last.\n",
"\n",
"### Russian"
]
},
Copy link

Choose a reason for hiding this comment

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

Thanks @IgnatovFedor !
Are there plans to fix such as "output is no a code cell", "List[List[scores]] -> List[List[scores]]"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants