Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
script: |
const marker = '<!-- memoizationkit-docs-preview -->';
const issue_number = context.issue.number;
const url = `https://lkdvos.github.io/MemoizationKit.jl/previews/PR${issue_number}/`;
const url = `https://quantumkithub.github.io/MemoizationKit.jl/previews/PR${issue_number}/`;
const body = `${marker}\n[Preview the documentation](${url})`;
const comments = await github.paginate(github.rest.issues.listComments, {
...context.repo,
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# MemoizationKit.jl

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://lkdvos.github.io/MemoizationKit.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://lkdvos.github.io/MemoizationKit.jl/dev/)
[![Build Status](https://github.com/lkdvos/MemoizationKit.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/lkdvos/MemoizationKit.jl/actions/workflows/Tests.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/lkdvos/MemoizationKit.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/lkdvos/MemoizationKit.jl)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://quantumkithub.github.io/MemoizationKit.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://quantumkithub.github.io/MemoizationKit.jl/dev/)
[![Build Status](https://github.com/QuantumKitHub/MemoizationKit.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/QuantumKitHub/MemoizationKit.jl/actions/workflows/Tests.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/QuantumKitHub/MemoizationKit.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/QuantumKitHub/MemoizationKit.jl)
[![Code Style: Runic](https://img.shields.io/badge/code_style-%F0%9F%AA%A8_Runic-9558B2)](https://github.com/fredrikekre/Runic.jl)
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

Expand Down Expand Up @@ -42,7 +42,7 @@ fib(200) # new results are kept in RAM and on disk

Calls look in RAM, then on disk, before computing.
Processes on the same machine share the database.
You control result versions and disk cleanup; see [disk caching](https://lkdvos.github.io/MemoizationKit.jl/dev/disk/).
You control result versions and disk cleanup; see [disk caching](https://quantumkithub.github.io/MemoizationKit.jl/dev/disk/).

## See what your caches are doing

Expand All @@ -63,14 +63,14 @@ The dashboard shows recent hit rates, storage use, and activity, with separate R
⇥ tab ↑↓ select ⏎ resize e empty s sort / filter q quit
```

See the [dashboard guide](https://lkdvos.github.io/MemoizationKit.jl/dev/dashboard/) for controls and statistics.
See the [dashboard guide](https://quantumkithub.github.io/MemoizationKit.jl/dev/dashboard/) for controls and statistics.

## Why MemoizationKit?

Choose MemoizationKit when memoization needs ongoing management: memory limits, reuse across runs, or visibility into a running workload.
It brings these tools together with strategies chosen by function and argument type.
For a single in-memory cache, Memoize.jl or Memoization.jl with an LRU container may already cover your needs.
See [the comparison and tradeoffs](https://lkdvos.github.io/MemoizationKit.jl/dev/#why-memoizationkit).
See [the comparison and tradeoffs](https://quantumkithub.github.io/MemoizationKit.jl/dev/#why-memoizationkit).

Requires Julia 1.10 or later.
Start with [usage](https://lkdvos.github.io/MemoizationKit.jl/dev/#usage), [configuration](https://lkdvos.github.io/MemoizationKit.jl/dev/configuration/), or [timing](https://lkdvos.github.io/MemoizationKit.jl/dev/timing/) in the [documentation](https://lkdvos.github.io/MemoizationKit.jl/dev/).
Start with [usage](https://quantumkithub.github.io/MemoizationKit.jl/dev/#usage), [configuration](https://quantumkithub.github.io/MemoizationKit.jl/dev/configuration/), or [timing](https://quantumkithub.github.io/MemoizationKit.jl/dev/timing/) in the [documentation](https://quantumkithub.github.io/MemoizationKit.jl/dev/).
4 changes: 2 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ makedocs(;
authors = "Lukas Devos",
sitename = "MemoizationKit.jl",
format = Documenter.HTML(;
canonical = "https://lkdvos.github.io/MemoizationKit.jl",
canonical = "https://quantumkithub.github.io/MemoizationKit.jl",
edit_link = "main",
assets = String[],
),
Expand All @@ -31,4 +31,4 @@ makedocs(;
],
)

deploydocs(; repo = "github.com/lkdvos/MemoizationKit.jl", devbranch = "main", push_preview = true)
deploydocs(; repo = "github.com/QuantumKitHub/MemoizationKit.jl", devbranch = "main", push_preview = true)
Loading