Skip to content
Merged

Page #84

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
87 changes: 78 additions & 9 deletions docs/_templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<h4>ON THIS PAGE</h4>
<ul>
<li><a href="#description">Description</a></li>
<li><a href="#improvements">Key improvements</a></li>
<li><a href="#latest-news">Latest News</a></li>
<li><a href="#documentation">Documentation</a></li>
<li><a href="#quick-start">Quick Start</a></li>
<li><a href="#links">Links</a></li>
Expand Down Expand Up @@ -68,21 +68,20 @@ <h1>Welcome to LLMSQL Project</h1>
<p style="margin-top:10px;">LLMSQL is a Python package for evaluation Hugging Face models on LLMSQL benchmark with transformers and vLLM.</p>
</div>

<h2 id="description">💡 Description</h2>
<h2 id="description">Description</h2>
<p><strong>LLMSQL Benchmark</strong> is an <strong>open-source framework</strong> providing a <strong>modernized, cleaned, and extended version of the original WikiSQL dataset</strong>, specifically designed for evaluating Hugging Face style <strong>Large Language Models (LLMs)</strong> on <strong>Text-to-SQL</strong> tasks.</p>

<h2 id="improvements">Key improvements</h2>
<ul>
<li><strong>Data Cleaning:</strong> Resolved duplicates, datatype mismatches, and inconsistent casing, reducing the widespread occurrence of empty query results.</li>
<li><strong>LLM-Ready Format:</strong> Reformatted SQL queries stored in WikiSQL’s custom encoding into standard SQL syntax.</li>
</ul>
<h2 id="latest-news">📣 Latest News</h2>
<div id="latest-news-container" class="custom-highlight-box">
<p>Loading latest news...</p>
</div>

<h2 id="documentation">📚 Documentation</h2>
<h2 id="documentation">Documentation</h2>
<div class="note-box">
<p><strong>Note:</strong> Documentation pages (installation guide, API reference) are <strong>under construction</strong>. <br> See <strong>Quick Start</strong> below or the README files inside the <a href="https://github.com/LLMSQL/llmsql-benchmark/" target="_blank">repo</a>.</p>
</div>

<h2 id="quick-start">Quick Start</h2>
<h2 id="quick-start">Quick Start</h2>
<div class="custom-highlight-box">
<p><strong>⚠️ WARNING — Reproducibility</strong></p>

Expand Down Expand Up @@ -150,6 +149,7 @@ <h2 id="links">🔗 Resources</h2>
<tr><td>📦 <strong>PyPI Project</strong></td><td><a href="https://pypi.org/project/llmsql/">llmsql on PyPI</a></td></tr>
<tr><td>💾 <strong>Dataset on Hugging Face</strong></td><td><a href="https://huggingface.co/datasets/llmsql-bench/llmsql-benchmark">llmsql-bench dataset</a></td></tr>
<tr><td>💻 <strong>Source Code</strong></td><td><a href="https://github.com/LLMSQL/llmsql-benchmark">GitHub repo</a></td></tr>
<tr><td>💻 <strong>Playground</strong></td><td><a href="https://huggingface.co/spaces/pihull/llmsql-interactive-q-a">HF Space</a></td></tr>
</tbody>
</table>

Expand Down Expand Up @@ -200,6 +200,75 @@ <h2 id="citation">📄 Citation</h2>
});
});
</script>
<script>
async function loadLatestNews() {
const container = document.getElementById("latest-news-container");

try {
const response = await fetch(
"https://api.github.com/repos/LLMSQL/llmsql-benchmark/readme"
);

const data = await response.json();
const content = atob(data.content);

const match = content.match(
/## Latest News[\s\S]*?(?=\n## |\n# |$)/
);

if (!match) {
container.innerHTML = "<p>No latest news found.</p>";
return;
}

const newsMarkdown = match[0]
.replace("## Latest News 📣", "")
.trim();

const lines = newsMarkdown
.split("\n")
.filter(l => l.startsWith("*"));

const htmlList = `
<ul>
${lines.map(line => {
const text = line.replace(/^\*\s*/, "");

const withLinks = text.replace(
/\[([^\]]+)\]\(([^)]+)\)/g,
(match, label, url) => {
if (url.startsWith("http://") || url.startsWith("https://")) {
return `<a href="${url}" target="_blank" rel="noopener">${label}</a>`;
}

const cleanPath = url.replace(/^\.\//, "");

const [path, anchor] = cleanPath.split("#");

const githubUrl =
"https://github.com/LLMSQL/llmsql-benchmark/blob/main/" +
path +
(anchor ? `#${anchor}` : "");

return `<a href="${githubUrl}" target="_blank" rel="noopener">${label}</a>`;
}
);

return `<li>${withLinks}</li>`;
}).join("")}
</ul>
`;

container.innerHTML = htmlList;

} catch (error) {
container.innerHTML =
"<p>Unable to load latest news from GitHub. See the repo yourself: https://github.com/LLMSQL/llmsql-benchmark/blob/main/</p>";
}
}

document.addEventListener("DOMContentLoaded", loadLatestNews);
</script>


</body>
Expand Down