LINUX.ORG.RU
ФорумTalks

ИИ'шка захавала документацию?

 


0

2

Надо было посмотреть справку по плюсовому API OpenCV. Во-первых, оно нихрена не гуглится, гугл упорно подставляет ссылку на какой-то PDF с китайского сайта (нафига мне PDF, алло!)

Но вот, вроде, нашёл, открываю примерчик для бинарного thresholding. На странице даже автор имеется, какая-то Ana, фамилии не буду называть. В сигнатуре метода там есть входной параметр «тип», ну типа разновидность алгоритма. И в примере просто выбирается магическая константа «3», без всяких макро-констант, энумов, просто магическая константа.

С какой целью так делается в справочной документации? IMHO только три причины: 1) автор кода - типичный сишный рукожоп, не имеющий ни малейшего понятия о профессиональном кодировании. 2) Автор специально хочет запутать читающего. Для справочной документации это терминальная клиника в отношение автора. 3) была применена ИИ’шка. Далее, приводятся картинки разных вариантов работы алгоритма. Но только это нафиг не нужно, потому что если человек захочет понять, как визуально что-то выглядит, ему надо знать, какой из режимов применен, а не «раз-два-три, приседают дубари».

★★★★★

На странице даже автор имеется, какая-то Ana, фамилии не буду называть.

ЧТО ТАМ?! Голдман? Голдберг? Либерман?

MoldAndLimeHoney ★★★
()
Ответ на: комментарий от MoldAndLimeHoney

В данном случае это не важно. Смысл в том, что подписался вроде бы живой человек, не ИИ-бот. Или тут уже тоже обман?

seiken ★★★★★
() автор топика
Последнее исправление: seiken (всего исправлений: 1)

Во-первых, как ты по константе определил что-то про «ИИ»?

Во-вторых, не надо искать в гугле, это плохой сайт. Есть официальный сайт продукта, ищи не нём.

firkax ★★★★★
()
Ответ на: комментарий от firkax

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

seiken ★★★★★
() автор топика
Ответ на: комментарий от seiken

Совсем не всегда. А вот бредогенератор как раз склонен больше использовать названия чем числа.

firkax ★★★★★
()
Ответ на: комментарий от firkax

Во-вторых, не надо искать в гугле, это плохой сайт. Есть официальный сайт продукта

opencv уже стал «продуктом»? Если это так, то это объясняет резкую деградацию качества доступной документации. К слову сказать, поиск на docs.opencv.org - обычное модерновое говнище на js и поисковых веб-говно-фреймворках, которое больше свистит и пердит, чем ищет нужную инфу.

В итоге, использование топовой ЛЛМ’ки оказывается не бонусом, а необходимым инструментом для любого практикующего кодера в 21м веке.

seiken ★★★★★
() автор топика
Последнее исправление: seiken (всего исправлений: 1)
Ответ на: комментарий от i7

Разве это не типичная документация? Так было всегда.

«А в ответ мне - видать был ты долго в пути, да людей позабыл, мы всегда так живем…»

LightDiver ★★★★★
()
Ответ на: комментарий от i7

Но это так же может означать, что API не предполагает автоматическую генерацию полноценной документации, просто потому что написан с оглядкой на сишку, причем сишку со старыми добрыми традициями «enum» - это же просто int…

seiken ★★★★★
() автор топика

посмотреть справку по плюсовому API OpenCV

Кстати да, забавно, но утка при закидывании в нее цитируемого куска первым пунктом выдает офсайт, а вот гугло всю первую страницу заливает разного рода хабрагноем. Впрочем, в иишной плашке таки предлагает офсайт в первую очередь.

Интересно, есть ли какие-то причины думать, что гугло делает это не специально.

thesis ★★★★★
()
Последнее исправление: thesis (всего исправлений: 2)

Автор специально хочет запутать читающего.

А как это. Если чел напишет неправильно код, то он же работать не будет. Или речь о комментарии?

TheNewDragon
()
Ответ на: комментарий от TheNewDragon

Качественный код должен быть по возможности самодокументирующим. Код «высрал - и порядок» может быть каким угодно.

seiken ★★★★★
() автор топика
Ответ на: комментарий от seiken

документация OpenCV всегда не отличалась полезностью для прикладных задач.

А если начать задаваться вопросами о том когда и в каких случаях освобождается память в cv::Mat, то становится понятно что и API гораздо менее высокоуровневое чем кажется на первый взгляд и требует очень много внимания к деталям.

GPFault ★★★
()
Ответ на: комментарий от seiken

я к тому что это не ИИшка, а пример исторически сложившейся документации, качество которой не меняется много лет.

GPFault ★★★
()
Ответ на: комментарий от seiken

opencv уже стал «продуктом»?

Что значит «стал»? Он им был с самого начала своего существования, как и любая другая прога или библиотека. Даже если ты напишешь за 5 минут какой-нить хелловорлд - это тоже будет продукт. Но без сайта, а у opencv сайт есть.

firkax ★★★★★
()
Последнее исправление: firkax (всего исправлений: 1)
Ответ на: комментарий от GPFault

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

seiken ★★★★★
() автор топика
Ответ на: комментарий от seiken

Очевидно, константа никого кроме тебя не тревожит, а картинки всем полезны.

Бывают ещё случаи (не знаю как тут - я даже не знаю о какой функции речь и вообще в opencv не разбираюсь), когда число само по себе имеет смысл, смене на другое никак не подлежит, и прятать его за названием наоборот вредить.

firkax ★★★★★
()
Последнее исправление: firkax (всего исправлений: 1)
Ответ на: комментарий от firkax

Так я не только хелловорл сегодня написал, я ещё создал 25 разновидностей продуктов компиляции. Только под продуктом даже в англоязычном сообществе понимается нечто большее, чем просто полезная и нужная библиотека.

seiken ★★★★★
() автор топика
Ответ на: комментарий от firkax

Очевидно, константа никого кроме тебя не тревожит, а картинки всем полезны.

Так никто просто не говорил во всеуслышание об этом. Большая часть сапиенсов - терпилы, и выполняют чужую работу за бесплатно.

seiken ★★★★★
() автор топика
Ответ на: комментарий от firkax

Случай опциональных флагов - это не тот случай.

seiken ★★★★★
() автор топика
Ответ на: комментарий от seiken

даже в англоязычном сообществе

Не надо на глупых иностранцев ориентироваться. Даже бесполезная и ненужная библиотека - продукт. Полезность никак не влияет на это утверждение.

firkax ★★★★★
()
Ответ на: комментарий от firkax

Наверное, действительно не стоит «ориентироваться на глупых иностранцев». Это спор терминологический и потому не особо интересный. А вот магические константы…

seiken ★★★★★
() автор топика
Ответ на: комментарий от seiken

я ещё создал 25 разновидностей продуктов компиляции

«Кто даёт продукт вторичный, тот питается отлично!» (с)

frob ★★★★★
()

ИИшка как раз бы сделала константу типа int kMyMagicConstant = 3, а человек напишет просто число

Reset ★★★★★
()
Ответ на: комментарий от TheNewDragon

Здесь не про «никто не мог разобраться», это передёргивание. В учебных примерах применения API понятность должна быть на первом месте в отрыве от всего остального. Это вовсе не то же самое, что абстрактный работающий код.

seiken ★★★★★
() автор топика
Ответ на: комментарий от MoldAndLimeHoney

Вполне возможно, что Нахасапимапетилон или что-то в этом роде.

Mischutka ★★★★★
()
Закрыто добавление комментариев для недавно зарегистрированных пользователей (со score < 50)