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
31 changes: 0 additions & 31 deletions .github/workflows/deploy-docs-to-azure.yaml

This file was deleted.

21 changes: 0 additions & 21 deletions docs/.gitignore

This file was deleted.

29 changes: 0 additions & 29 deletions docs/README.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/babel.config.js

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
sidebar_position: 2
title: "How Codeflash Measures Code Runtime"
description: "Learn how Codeflash accurately measures code performance using multiple runs and minimum timing"
icon: "stopwatch"
sidebarTitle: "Runtime Measurement"
keywords: ["benchmarking", "performance", "timing", "measurement", "runtime", "noise reduction"]
---

# How Codeflash measures code runtime
Expand Down Expand Up @@ -70,7 +74,7 @@ You ask the driver to repeat the race multiple times. In this scenario, since th

This gives us timing data (in hours) that looks like the following.

![img_2.png](img_2.png)
![img_2.png](./img_2.png)

With 100 data points (50 per train), determining the faster train becomes more complex.

Expand Down Expand Up @@ -120,7 +124,7 @@ We can only measure times between adjacent stations.

Here is how the timing data looks like (in hours):

![img_1.png](img_1.png)
![img_1.png](./img_1.png)

With 300 data points (50 runs × 3 segments × 2 trains) and varying conditions on each segment,
determining the faster train becomes even more challenging.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
sidebar_position: 1
title: "How Codeflash Works"
description: "Understand Codeflash's generate-and-verify approach to code optimization and correctness verification"
icon: "gear"
sidebarTitle: "How It Works"
keywords: ["architecture", "verification", "correctness", "testing", "optimization", "LLM", "benchmarking"]
---
# How Codeflash Works

Expand All @@ -24,7 +28,7 @@ Codeflash currently only runs tests that directly call the target function in th
To optimize code, Codeflash first gathers all necessary context from the codebase. It also line-profiles your code to understand where the bottlenecks might reside. It then calls our backend to generate several candidate optimizations. These are called "candidates" because their speed and correctness haven't been verified yet. Both properties will be verified in later steps.
## Verification of correctness

![Verification](/img/codeflash_arch_diagram.gif)
![Verification](/images/codeflash_arch_diagram.gif)

The goal of correctness verification is to ensure that when the new code replaces the original code, there are no behavioral changes in the code and the rest of the system. This means the replacement should be completely safe.

Expand Down
6 changes: 5 additions & 1 deletion docs/docs/configuration.md → docs/configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
sidebar_position: 5
title: "Manual Configuration"
description: "Configure Codeflash for your project with pyproject.toml settings and advanced options"
icon: "gear"
sidebarTitle: "Configuration"
keywords: ["configuration", "pyproject.toml", "setup", "settings", "pytest", "formatter"]
---

# Manual Configuration
Expand Down
115 changes: 115 additions & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "aspen",
"name": "Codeflash Documentation",
"colors": {
"primary": "#2563EB",
"light": "#3B82F6",
"dark": "#1D4ED8"
},
"favicon": "/favicon.ico",
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "🏠 Overview",
"pages": [
"index"
]
},
{
"group": "🚀 Getting Started",
"pages": [
"getting-started/local-installation"
]
},
{
"group": "🔧 CI/CD Integration",
"pages": [
"getting-started/codeflash-github-actions",
"optimizing-with-codeflash/optimize-prs",
"optimizing-with-codeflash/benchmarking"
]
},
{
"group": "⚡ Optimization Workflows",
"pages": [
"optimizing-with-codeflash/one-function",
"optimizing-with-codeflash/trace-and-optimize",
"optimizing-with-codeflash/codeflash-all"
]
},
{
"group": "🧠 Core Concepts",
"pages": [
"codeflash-concepts/how-codeflash-works",
"codeflash-concepts/benchmarking"
]
},
{
"group": "⚙️ Configuration & Best Practices",
"pages": [
"configuration",
"getting-the-best-out-of-codeflash"
]
}
]
}
],
"global": {
"anchors": [
{
"anchor": "GitHub",
"href": "https://github.com/codeflash-ai",
"icon": "github"
},
{
"anchor": "Discord",
"href": "https://www.codeflash.ai/discord",
"icon": "discord"
}
]
}
},
"logo": {
"light": "/images/codeflash_light.svg",
"dark": "/images/codeflash_darkmode.svg"
},
"navbar": {
"links": [
{
"label": "Contact",
"href": "mailto:contact@codeflash.ai"
},
{
"label": "Blog",
"href": "https://www.codeflash.ai/blog"
}
],
"primary": {
"type": "button",
"label": "Try Codeflash",
"href": "https://www.codeflash.ai"
}
},
"contextual": {
"options": [
"copy"
]
},
"redirects": [
{
"source": "/docs/:path*",
"destination": "/:path*"
}
],
"footer": {
"socials": {
"discord": "https://www.codeflash.ai/discord",
"github": "https://github.com/codeflash-ai",
"linkedin": "https://www.linkedin.com/company/codeflash-ai"
}
}
}
5 changes: 0 additions & 5 deletions docs/docs/codeflash-concepts/_category_.json

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs/getting-started/_category_.json

This file was deleted.

Loading
Loading