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

Documentation index #8

Merged
merged 3 commits into from
Jun 6, 2022
Merged

Documentation index #8

merged 3 commits into from
Jun 6, 2022

Conversation

ivkireev86
Copy link
Collaborator

Прототип главной страницы документации.
Три секции:

  • описание моделей библиотеки
  • гайд как использовать библиотеку
  • как писать свои компоненты

Есть краткое описание и ссылки на подробные (которые напишем потом).

В описании модулей предложена структура библиотеки. Предполагается, что мы эти модули в ближайшее создадим и перетащим туда соответсвующие классы из библиотеки. Старые, модули, которые станут пустыми, удалим. Далее будем придерживаться схемы, описанной в этом документе.

На ревью предлагается чекнуть предлагаемую структуру библиотеки, названия модулей ну и сам описательный текст документа.

@ivkireev86 ivkireev86 requested a review from dllllb May 27, 2022 11:00
@ivkireev86
Copy link
Collaborator Author

ivkireev86 commented Jun 1, 2022

И следующий шаг - по пунктам из How to guide подготовить короткие демо, каждое из которых описывает кусочек по реализации одного шага. Хотя такие короткие демо лучше показать прямо в документации. Это будет всего пара строчек, как например сейчас это сделано в pytorch.
Полное демо будет как сейчас, только названия разделов нужно будет синхронизировать с How to guide. Привести в нем ссылки на альтернативные варианты для каждого шага.

docs/index.md Outdated
- Split data into required parts (train, valid, test, ...).
- Transform features to compatible format using pyspark or pandas functions.
You can use also `ptls.data.preprocessing` for common data transformation patterns.
- Split sequences to ptls-data format with `ptls.data.split_tools`. Save prepared data into parquet format or
Copy link
Owner

Choose a reason for hiding this comment

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

Parquet имеет смысл выдлелить, Pandas, Parquet, с большой буквы

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Может их ссылками сделать?

Copy link
Owner

Choose a reason for hiding this comment

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

можно, но думаю не обязательно

docs/index.md Outdated
2. **Choose framework for encoder train**.
- There are both supervised of unsupervised in `ptls.lightning_modules`.
- Keep in mind that each framework requires his own batch format.
Tools for batch collate are near selected framework.
Copy link
Owner

Choose a reason for hiding this comment

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

can be found in the selected framework package?

docs/index.md Outdated
Tools for batch collate are near selected framework.
3. **Build encoder**.
- All parts are available in `ptls.trx_encoder`, `ptls.seq_encoder`, `ptls.heads`.
- You can use early pretrained layers.
Copy link
Owner

Choose a reason for hiding this comment

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

You can also use pretrained layers

Copy link
Owner

@dllllb dllllb left a comment

Choose a reason for hiding this comment

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

В целом структура ок, есть небольшие комментарии по тексту, его можно будет постепенно улучшать

@ivkireev86 ivkireev86 merged commit b71c04b into main Jun 6, 2022
@ikretus ikretus deleted the doc_index branch August 2, 2022 09:49
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.

2 participants