From aa9fa47df39925f67f584c0307d8378aec671d29 Mon Sep 17 00:00:00 2001 From: sergey Date: Mon, 25 Nov 2024 11:20:21 +0300 Subject: [PATCH 1/2] fix README.md --- README.md | 129 +++++++++++++++++++++++++++++------------------------- 1 file changed, 69 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index e7b6942..02afd0f 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,102 @@ -# Timacad Framework +--- +# Документация Timacad Framework +**Timacad Framework** — это модульный инструмент для обработки изображений, построенный на основе модели YOLO, позволяющий выполнять задачи сегментации и обнаружения объектов. Основной функционал включает: -## Getting started +- Загрузка и использование локальных моделей. +- Обработка изображений с выводом результата в формате JSON или аннотированного изображения. +- Простая интеграция с другими проектами. -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +## Установка -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +1. **Клонируйте репозиторий**: + ```bash + git clone <адрес репозитория> + cd timacad-framework + ``` -## Add your files +2. **Установите зависимости**: + ```bash + pip install -r requirements.txt + ``` -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +## Структура проекта -``` -cd existing_repo -git remote add origin http://ai.timacad.ru/gitlab/aiteam/timacad-framework.git -git branch -M main -git push -uf origin main -``` +- `timacad_framework.py`: Основной класс для управления моделями и их инициализации. +- `image_processor.py`: Утилиты для обработки изображений, работы с YOLO и генерации результатов. +- `test_of_framework.py`: Пример использования фреймворка. -## Integrate with your tools +--- -- [ ] [Set up project integrations](http://ai.timacad.ru/gitlab/aiteam/timacad-framework/-/settings/integrations) +## Как использовать -## Collaborate with your team +### 1. Инициализация -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +Фреймворк поддерживает локальную загрузку моделей. Используйте метод `create` для создания объекта `ImageProcessor` с заданной моделью. -## Test and Deploy +```python +from timacad_framework import TimacadFramework -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +# Создаем объект с моделью "blood_cells" +processor = TimacadFramework.create("local", "blood_cells") +``` -*** +### 2. Обработка изображений -# Editing this README +Вы можете обработать изображение с использованием метода `process`: -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +```python +# Указываем путь к изображению +image_path = "path/to/image.jpg" -## Suggestions for a good README +# Получение результата в формате JSON +result_json = processor.process(image_path, output_type='json') -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +# Сохранение аннотированного изображения +result_jpg = processor.process(image_path, output_type='jpg') +with open("output.jpg", "wb") as f: + f.write(result_jpg.getbuffer()) +``` -## Name -Choose a self-explaining name for your project. +### 3. Конфигурация моделей -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +Модели должны находиться в папке `models`. Поддерживаются следующие типы моделей: +- `blood_cells` — модель для сегментации клеток крови. +- `segmentation_of_fields` — модель для сегментации полей. -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +Пример пути к модели: +``` +models/BloodCells.pt +models/SegmentationOfFields.pt +``` -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +--- -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +## Пример использования -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +См. файл `test_of_framework.py`: -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +```python +# Загрузка изображения +pic_path = TimacadFramework.get_normalized_path(base_path, "pictures", "2.jpg") -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +# Создание объекта для обработки +processor = TimacadFramework.create("local", "blood_cells") -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +# Обработка изображения +result_json = processor.process(pic_path, output_type='json') -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +# Сохранение результата +with open("output.json", "w", encoding="utf-8") as f: + json.dump(result_json, f, ensure_ascii=False, indent=4) +``` -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +--- -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +## Ограничения -## License -For open source projects, say how it is licensed. +- В текущей версии поддерживается только локальная обработка. +- Формат входных данных: JPG или совместимые изображения. -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +--- -- GitLab From 8fdb9133ccbad972d148806f4f6170b72377864d Mon Sep 17 00:00:00 2001 From: sergey Date: Mon, 25 Nov 2024 11:22:31 +0300 Subject: [PATCH 2/2] fix README.md --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 02afd0f..5781f56 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ ---- - # Документация Timacad Framework **Timacad Framework** — это модульный инструмент для обработки изображений, построенный на основе модели YOLO, позволяющий выполнять задачи сегментации и обнаружения объектов. Основной функционал включает: @@ -98,5 +96,3 @@ with open("output.json", "w", encoding="utf-8") as f: - В текущей версии поддерживается только локальная обработка. - Формат входных данных: JPG или совместимые изображения. - ---- -- GitLab