From 9689c9f2d0052b961c911806f707eb6ef56bddf7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laure=CE=B7t?= Date: Sun, 3 Sep 2023 14:45:40 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20add=20DocumenterCitations=20and?= =?UTF-8?q?=20a=20couple=20references?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Project.toml | 1 + docs/make.jl | 7 +++++-- docs/src/references.md | 8 ++++++++ docs/src/refs.bib | 35 +++++++++++++++++++++++++++++++++++ 4 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 docs/src/references.md create mode 100644 docs/src/refs.bib diff --git a/docs/Project.toml b/docs/Project.toml index ce47589..db611c8 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,5 +1,6 @@ [deps] Diffusers = "90edb7a8-79d7-49b2-b6b1-9322c3fdead8" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244" LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f" PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a" diff --git a/docs/make.jl b/docs/make.jl index 98bf9f9..bed2aba 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,16 +1,18 @@ using Diffusers using Documenter +using DocumenterCitations DocMeta.setdocmeta!(Diffusers, :DocTestSetup, :(using Diffusers); recursive=true) +bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib")) -makedocs(; +makedocs(bib; modules=[Diffusers], authors="Laurent Fainsin ", repo="https://github.com/Laurent2916/Diffusers.jl/blob/{commit}{path}#{line}", sitename="Diffusers.jl", format=Documenter.HTML(; prettyurls=true, - edit_link="main", + edit_link="master", assets=String[] ), linkcheck=true, @@ -18,6 +20,7 @@ makedocs(; "Home" => "index.md", "Schedulers" => "schedulers.md", "Beta Schedules" => "beta_schedules.md", + "References" => "references.md", ] ) diff --git a/docs/src/references.md b/docs/src/references.md new file mode 100644 index 0000000..e402322 --- /dev/null +++ b/docs/src/references.md @@ -0,0 +1,8 @@ +# References + +```@bibliography +``` + +```@bibliography +* +``` diff --git a/docs/src/refs.bib b/docs/src/refs.bib new file mode 100644 index 0000000..a25be3b --- /dev/null +++ b/docs/src/refs.bib @@ -0,0 +1,35 @@ +@misc{ho2020denoising, + title = {Denoising Diffusion Probabilistic Models}, + author = {Jonathan Ho and Ajay Jain and Pieter Abbeel}, + year = {2020}, + eprint = {2006.11239}, + archiveprefix = {arXiv}, + primaryclass = {cs.LG} +} + +@misc{song2022denoising, + title = {Denoising Diffusion Implicit Models}, + author = {Jiaming Song and Chenlin Meng and Stefano Ermon}, + year = {2022}, + eprint = {2010.02502}, + archiveprefix = {arXiv}, + primaryclass = {cs.LG} +} + +@misc{luo2022understanding, + title = {Understanding Diffusion Models: A Unified Perspective}, + author = {Calvin Luo}, + year = {2022}, + eprint = {2208.11970}, + archiveprefix = {arXiv}, + primaryclass = {cs.LG} +} + +@misc{nichol2021improved, + title = {Improved Denoising Diffusion Probabilistic Models}, + author = {Alex Nichol and Prafulla Dhariwal}, + year = {2021}, + eprint = {2102.09672}, + archiveprefix = {arXiv}, + primaryclass = {cs.LG} +}