Kada se renderuje, ovaj blok se pojavljuje kao standardni primer koda. Tokom testiranja, međutim, izvršava se kao normalan Python kod. Ova dvostruka priroda osigurava da dokumentacija ostaje čista za čitaoce, dok pruža robusne primere koji se mogu testirati za programere. Ovaj pristup je posebno značajan za složene domene poput AI, gde primeri često uključuju složeno učitavanje modela i korake inferencije.
## Besprekorna integracija sa `pytest`-om i naprednim funkcijama
Ključna razlika Hugging Face-ovog pristupa je njegova besprekorna integracija sa modernim okvirima za testiranje, posebno sa `pytest`-om. Sa instaliranim `hf-doc-builder`-om, `pytest` može automatski da otkrije i izvrši izvršne blokove unutar Markdown datoteka, tretirajući svaki blok kao standardnu test stavku. To znači da primeri iz dokumentacije mogu u potpunosti učestvovati u postojećoj test infrastrukturi projekta, koristeći moćne `pytest` funkcije kao što su provere, fixturi, dekoratori i alati za debagovanje, kao i sveobuhvatno izveštavanje.
### Evolucija izvršne dokumentacije: `doctest` vs. `doc-builder`
| Funkcija | `doctest` (Tradicionalni) | `doc-builder` (Moderni izvršni Markdown) |
| :--------------------------- | :------------------------------------------------- | :-------------------------------------------- |
| **Pristup testiranju** | Ugrađuje testove kao sesije interpretera u dokumentaciju | Tretira isečke dokumentacije kao normalan Python kod za testiranje |
| **Integracija** | Modul standardne biblioteke | `pytest` plugin za besprekornu integraciju |
| **Sintaksa testa** | `>>>` promptovi, podudaranje očekivanog izlaza | Standardni Python kod, `pytest` provere |
| **Fleksibilnost** | Ograničena, krhko podudaranje izlaza | Visoka, podržava složene testove, dekoratore, debagovanje |
| **Čistoća dokumentacije** | Može pretrpati dokumentaciju mehanikom testiranja | Čuva čistu dokumentaciju sa skrivenim direktivama |
| **Debagovanje** | Poređenje stringova, manje direktna inspekcija | Standardno Python debagovanje, potpuni tragovi grešaka |
| **Podešavanje/Uklanjanje** | Može dodati šum primerima | Efikasno upravlja kontekstom sa blokovima za nastavak |
| **Izvor istine** | Format dokumentacije i ugrađeni testovi | Markdown izvor, testiran standardnim Python izvršavanjem |
`doc-builder` takođe uvodi **blokove za nastavak**, ključnu funkciju za višestepene tutorijale. Oni omogućavaju autorima da podele primer na više vidljivih isečaka, kao što je `runnable:test_basic` praćen sa `runnable:test_basic:2`. Ono što je ključno, ovi blokovi dele isti kontekst izvršavanja tokom testova, omogućavajući prirodan tok instrukcija bez prisiljavanja celog koda u jedan dugačak blok. Ova fleksibilnost je vitalna za vođenje korisnika kroz složenu upotrebu AI modela ili pipeline-e za obradu podataka.
Na primer, radni tok razvoja AI agenta mogao bi uključivati nekoliko koraka: definisanje alata agenta, inicijalizaciju agenta, a zatim pokretanje upita. Blokovi za nastavak omogućavaju da se svaki od ovih koraka jasno predstavi u posebnim odeljcima dokumentacije dok se izvršavaju kao jedinstvena, kohezivna testna sekvenca, slično kao što su napredni agentski radni tokovi [Operationalizing Agentic AI: Part 1](/sr/operationalizing-agentic-ai-part-1-a-stakeholders-guide).
## Održavanje čiste dokumentacije uz osiguravanje robusnog testiranja
Jedno od najelegantnijih rešenja `doc-builder`-a je njegova sposobnost da održi renderovanu dokumentaciju čistom, čak i kada izvorni Markdown sadrži direktive specifične za testiranje. Programeri mogu ugraditi komentare poput `# doc-builder: hide` za izvršne linije koje ne bi trebalo da se pojavljuju u dokumentaciji, ili `# doc-builder: ignore-bare-assert` za provere koje su deo testa, ali čiji komentar ne bi trebalo da bude renderovan. Slično tome, `pytest` dekoratori (`# pytest-decorator: ...`) se uklanjaju tokom renderovanja.
Ovo osigurava da dokumentacija ostaje fokusirana na podučavanje i jasnoću, bez da bude pretrpana boilerplate kodom za testiranje. Korisnik vidi samo relevantan kod, dok osnovni sistem garantuje njegovu funkcionalnost. Ovaj balans je kritičan za dokumentaciju alata za programere, gde su i estetski izgled i apsolutna ispravnost od presudnog značaja.
## Uticaj na velike AI projekte i šire
Za masivne repozitorijume poput Hugging Face-ovih Transformers, sa stotinama stranica dokumentacije i hiljadama primera, ova funkcija je transformativna. Ona automatizuje sprečavanje zastarelosti dokumentacije, problema koji bi inače zahtevao ogroman ručni napor ili doveo do konstantnog toka pokvarenih primera. Izvršna dokumentacija pomaže da se dokumentacija i kodna baza održe sinhronizovanim, održavajući pouzdanost u obimu gde je ručna provera jednostavno neizvodljiva. Ovo se usklađuje sa širim naporima u AI zajednici da rigorozno [Evaluating AI Agents for Production](/sr/evaluating-ai-agents-for-production-a-practical-guide-to-strands-evals) i osigura pouzdanost.
Donoseći izvršnu dokumentaciju u modernu eru `pytest`-a i sofisticiranih CI/CD pipeline-a, Hugging Face pokazuje snažnu posvećenost iskustvu programera i kvalitetu koda. Cilj ostaje isti kao i pre više od dve decenije: primeri u dokumentaciji treba da rade. Ali sada, oni ne samo da ilustruju kako kod *treba* da radi, već neprekidno *dokazuju* da radi, podstičući pouzdaniji ekosistem za razvoj AI.
Originalni izvor
https://huggingface.co/blog/huggingface/runnable-examplesČesto postavljana pitanja
What is the core problem Hugging Face's runnable Markdown addresses?
Hugging Face's runnable Markdown addresses the pervasive problem of 'documentation drift,' where code examples in documentation become outdated and silently break as libraries and APIs evolve. This leads to user frustration and diminishes the credibility of the documentation. By making documentation examples runnable and testable, the doc-builder ensures that these snippets are continuously validated against the codebase, guaranteeing that they always work as advertised. This proactive approach prevents broken examples, enhances user trust, and improves the overall developer experience by providing reliable resources.
How does runnable Markdown differ from Python's traditional `doctest` module?
While both `doctest` and runnable Markdown aim for executable documentation, they differ significantly in their approach. `doctest` embeds tests directly into documentation syntax, requiring examples to mirror interactive interpreter sessions with expected output. This often leads to documentation being cluttered with test mechanics. Hugging Face's runnable Markdown, in contrast, treats documentation snippets as normal Python code living within Markdown files. It integrates seamlessly with modern testing frameworks like `pytest`, allowing for complex assertions, debugging, and standard test infrastructure. This separation of concerns ensures documentation remains clean and readable, while testing remains powerful and flexible, avoiding the limitations of `doctest`'s brittle output matching and verbose setup/teardown.
What are 'continuation blocks' in Hugging Face's `doc-builder`?
Continuation blocks are a powerful feature in Hugging Face's `doc-builder` that allow authors to split complex code examples or tutorials across multiple visible Markdown snippets while maintaining a shared execution context during testing. This means that a setup defined in one runnable block can be reused and built upon in a subsequent block, without forcing the documentation to present everything as one long, monolithic code fence. For example, `runnable:test_basic` can define initial variables, and `runnable:test_basic:2` can then use those variables. This enhances readability and instructional flow in documentation, making it easier to present multi-step processes without sacrificing the integrity of the underlying testable code.
How does `doc-builder` integrate with existing testing frameworks like `pytest`?
Hugging Face's `doc-builder` integrates natively with `pytest`, transforming runnable Markdown blocks into standard `pytest` test items. With `hf-doc-builder` installed, `pytest` automatically discovers and executes these blocks within Markdown files. This integration means that documentation examples can leverage the full power of `pytest`, including its assertion mechanisms, fixtures, decorators, and debugging tools. Failures appear as normal test failures with comprehensive tracebacks, allowing developers to debug effectively. This approach avoids the need for a special-purpose testing mini-language, embedding documentation tests directly into the project's existing, robust test infrastructure.
How does `doc-builder` ensure documentation remains clean despite embedded test logic?
A key design principle of `doc-builder` is to prevent test mechanics from polluting the user-facing documentation. Authors can embed test-only directives, such as `# pytest-decorator: transformers.testing_utils.slow` or `# doc-builder: hide` for lines that should be executable but not displayed, directly within the Markdown source. When the documentation is rendered, `doc-builder` intelligently strips these directives and comments, presenting a clean, readable code snippet to the user. This allows developers to write comprehensive tests alongside their examples without compromising the clarity and brevity expected of good documentation, maintaining a clear separation between the source code for testing and the rendered content for users.
What are the benefits of runnable documentation for large AI projects like Hugging Face Transformers?
For large AI projects such as Hugging Face Transformers, which involve extensive documentation and thousands of code examples, runnable documentation offers immense benefits. It drastically reduces 'documentation drift' by continuously validating examples against the evolving codebase, ensuring they remain accurate and functional. This prevents user frustration caused by broken examples and builds trust in the documentation's reliability. By integrating with `pytest`, it allows these projects to manage documentation tests within their existing CI/CD pipelines, making manual review of examples unnecessary at scale. This automated validation is crucial for maintaining the quality and usability of documentation in rapidly developing and complex software ecosystems.
Can runnable Markdown be adopted by other projects outside of Hugging Face?
Yes, the principles and mechanisms behind Hugging Face's runnable Markdown, particularly its integration with standard Python testing tools like `pytest` and its focus on separating testing logic from displayed documentation, are highly applicable and beneficial for any software project. While the `doc-builder` itself is specific to Hugging Face, the underlying ideas represent a best practice in developer tools. Other projects can implement similar systems using existing tools or adapt `doc-builder`'s concepts to ensure their documentation examples are continuously tested and reliable. This approach is a general solution to a common problem across the software development landscape, making documentation more robust and trustworthy.
Будите у току
Примајте најновије AI вести на имејл.