diff --git a/.github/workflows/blueprint.yml b/.github/workflows/blueprint.yml index 8ae3ddf0..95addedf 100644 --- a/.github/workflows/blueprint.yml +++ b/.github/workflows/blueprint.yml @@ -56,7 +56,7 @@ jobs: ./build_all.sh - name: Compile blueprint and documentation - uses: leanprover-community/docgen-action@deed0cdc44dd8e5de07a300773eb751d33e32fc8 # 2025-10-26 + uses: leanprover-community/docgen-action@7b5b9a1822650bd45aaeb4182d94bceba2030f89 # 2026-04-14 with: homepage: home_page blueprint: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 079dcadf..c48c0d08 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Fork the repository and create a new branch for your contribution. Make your cha ## What to contribute -See the [Roadmap](https://remydegenne.github.io/lean-bandits/roadmap). +See the [Roadmap](https://leanmachinelearning.github.io/roadmap/). #### Finding tasks diff --git a/blueprint/src/web.tex b/blueprint/src/web.tex index 866281c3..15f39f04 100644 --- a/blueprint/src/web.tex +++ b/blueprint/src/web.tex @@ -16,9 +16,9 @@ \graphcolor{mathlib}{purple}{The statement of this result is in Mathlib} -\home{https://RemyDegenne.github.io/lean-bandits} -\github{https://github.com/RemyDegenne/lean-bandits} -\dochome{https://RemyDegenne.github.io/lean-bandits/docs} +\home{https://leanmachinelearning.github.io} +\github{https://github.com/LeanMachineLearning/LML} +\dochome{https://leanmachinelearning.github.io/LML/docs} \title{Lean Machine Learning} \author{Rémy Degenne, Paulo Rauber} diff --git a/scripts/customize_template.py b/scripts/customize_template.py deleted file mode 100755 index 263798c4..00000000 --- a/scripts/customize_template.py +++ /dev/null @@ -1,80 +0,0 @@ -#!/usr/bin/env python3 - -""" -This script provides functions to customize the project template by replacing text in files, -renaming directories, and performing other necessary setup steps. -""" - -import os -import sys - -def replace_text_in_file(filepath, old_text, new_text): - """ - Replace all occurrences of old_text with new_text in the specified file. - - Arguments: - filepath (str): The path to the file where text needs to be replaced. - old_text (str): The text to be replaced. - new_text (str): The text to replace with. - """ - with open(filepath, 'r') as file: - filedata = file.read() - - filedata = filedata.replace(old_text, new_text) - - with open(filepath, 'w') as file: - file.write(filedata) - -def rename_directory(old_name, new_name): - """ - Rename a directory from old_name to new_name. - - Arguments: - old_name (str): The current name of the directory. - new_name (str): The new name for the directory. - """ - if os.path.exists(old_name): - os.rename(old_name, new_name) - -def main(project_name): - """ - Perform all the customization steps for the template. - - Arguments: - project_name (str): The name of the new project. - """ - # Define paths to the files and directories to be modified - project_folder = 'Project' - contributing_md = 'CONTRIBUTING.md' - lakefile_toml = 'lakefile.toml' - docbuild_lakefile_toml = 'docbuild/lakefile.toml' - project_lean = 'Project.lean' - build_project_yml = '.github/workflows/build-project.yml' - - # Replace 'Project' with the actual project name in the necessary files - replace_text_in_file(lakefile_toml, 'Project', project_name) - replace_text_in_file(docbuild_lakefile_toml, 'Project', project_name) - replace_text_in_file(build_project_yml, 'Project', project_name) - - # Rename 'Project' folder to match the project name - rename_directory(project_folder, project_name) - - # Notify the user to customize 'CONTRIBUTING.md' manually - print(f"Please customize {contributing_md} manually to set up the contribution guidelines for your project.") - - # Rename 'Project.lean' to match the project name and update imports - if os.path.exists(project_lean): - new_project_lean = f"{project_name}.lean" - os.rename(project_lean, new_project_lean) - replace_text_in_file(new_project_lean, 'Project', project_name) - -if __name__ == "__main__": - # Check if the script is executed with the correct number of command-line arguments - if len(sys.argv) != 2: - print("Usage: python customize_template.py ") - sys.exit(1) - - # Get the project name from the command-line arguments - project_name = sys.argv[1] - # Call the main function to perform the customization - main(project_name) diff --git a/scripts/update.sh b/scripts/update.sh deleted file mode 100755 index ad677545..00000000 --- a/scripts/update.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env bash - -# Update Mathlib and the Lean toolchain. - -# Download the latest lean-toolchain file from the Mathlib4 repository -curl -L https://raw.githubusercontent.com/leanprover-community/mathlib4/master/lean-toolchain -o lean-toolchain - -# Update the Mathlib dependencies and ensure doc-gen is also updated -# The `-R -Kenv=dev` flag ensures that the development environment is updated, including doc-gen -lake -R -Kenv=dev update diff --git a/tutorial/Manual.lean b/tutorial/Manual.lean index 39642360..12eef0ac 100644 --- a/tutorial/Manual.lean +++ b/tutorial/Manual.lean @@ -12,8 +12,8 @@ def extraHead : Array Verso.Output.Html := #[ def config : RenderConfig := { extraHead := extraHead, - sourceLink := some "https://github.com/RemyDegenne/lean-bandits", - issueLink := some "https://github.com/RemyDegenne/lean-bandits/issues", + sourceLink := some "https://github.com/LeanMachineLearning/LML", + issueLink := some "https://github.com/LeanMachineLearning/LML/issues", } def main := manualMain (%doc Manual.Front) (config := config) diff --git a/tutorial/Manual/Pages/Installation.lean b/tutorial/Manual/Pages/Installation.lean index fb2b8634..5dd09dc9 100644 --- a/tutorial/Manual/Pages/Installation.lean +++ b/tutorial/Manual/Pages/Installation.lean @@ -28,11 +28,11 @@ There are two ways to get the library depending on your needs: Move to a directory where you want to store the library, then run: ``` -git clone https://github.com/remydegenne/lean-bandits.git -cd lean-bandits +git clone https://github.com/LeanMachineLearning/LML.git +cd LML ``` This will create a local copy of the repository on your machine and move to the project directory. -We then need to buid the project. +We then need to build the project. ``` lake exe cache get lake build @@ -48,7 +48,7 @@ To use the library in your own Lean project (see the Lean installation instructi ``` [[require]] name = "LeanMachineLearning" -git = "https://github.com/leanprover/lean-bandits" +git = "https://github.com/LeanMachineLearning/LML" ``` # Testing the installation