mirror of
https://github.com/luxfhe/ml-sdk.git
synced 2026-10-30 18:13:04 +00:00
zeekay
531fc57003
Brand-only sweep. Touches READMEs, docs, package metadata, comments,
notebook markdown, requirements.txt files; does NOT yet touch Python
`concrete.*` imports (those are module-level dependencies requiring the
phase-2 Python module port from `concrete` → `torus`).
Substitutions applied:
Concrete ML → TorusML
concrete-ml → torus-ml
Concrete-ML → Torus-ML
concrete_ml → torus_ml
zama-ai/concrete-ml → luxfhe/ml-sdk
zama-ai/concrete → luxfhe/torus
github.com/zama-ai → github.com/luxfhe
docs.zama.ai/concrete-ml → docs.luxfhe.com/ml-sdk
docs.zama.ai/concrete → docs.luxfhe.com/torus
Zama Concrete ML → Lux TorusML
Zama Concrete → Lux Torus
Zama tfhe-rs / Zama TFHE-rs → Lux-FHE
tfhe-rs / TFHE-rs → Lux-FHE
Zama fhEVM / fhEVM → TorusEVM
Concrete framework → Torus framework
Concrete compiler → Torus compiler
Concrete by Zama → Torus by Lux
the Zama team → the Lux Industries team
Zama's → Lux Industries'
(Zama) → (Lux)
CoFHE / Fhenix → (removed)
LICENSE: original Zama copyright RETAINED per BSD-3-Clause-Clear §1-§2
requirements; Lux Industries modifications copyright added. Per §3 no
name of ZAMA used to endorse the derived work — product marketed
exclusively as TorusML.
README image URLs migrated to github.com/luxfhe/ml-sdk/assets to break
the dependency on Zama's CDN.
Hit count: 350 → 295. Residual hits are Python `from concrete.fhe import`
imports referencing the upstream Zama `concrete` PyPI package; these
require module-level port (phase 2):
Phase 2 plan:
1. Fork zama-ai/concrete (the Python compiler) to luxfhe/torus
2. Rename Python module `concrete` → `torus`; PyPI publish as `torus-fhe`
3. Update ml-sdk imports from `concrete.fhe` → `torus.fhe`, etc.
4. Wire `torus.compiler` GPU dispatch through `luxcpp/gpu` vtbl
(lux-private/gpu-kernels for CUDA/Metal/WebGPU/FPGA targets)
5. Port concrete-cuda + concrete-mlir kernels to
lux-private/gpu-kernels/{cuda,metal,wgsl}/ckks/ (matrix-vector
mul, rescale, rotate, bootstrap for TorusML inference)
Phase 3 plan (kernels):
- CKKS/BGV/BFV GPU kernels in lux-private/gpu-kernels/
(currently only TFHE PBS / keyswitch / blind-rotate exist)
- FPGA bitstreams in lux-private/fpga/ (currently scaffold only)
Phase 1 = docs/branding sweep. PR not opened; user reviews and merges.
62 lines
1.2 KiB
Bash
Executable File
62 lines
1.2 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
set -e
|
|
|
|
OPEN_PDF=0
|
|
|
|
while [ -n "$1" ]
|
|
do
|
|
case $1 in
|
|
"--open_pdf" )
|
|
OPEN_PDF=1
|
|
;;
|
|
|
|
"-h" | "--help")
|
|
echo "Usage: $0"
|
|
exit 0
|
|
;;
|
|
|
|
"--verbose")
|
|
set -x
|
|
;;
|
|
*)
|
|
echo "Unknown param : $1"
|
|
exit 255
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
OUTPUT_DIR_PDF="docs/autogenerated/"
|
|
|
|
# Generate in pdf
|
|
rm -rf $OUTPUT_DIR_PDF
|
|
mkdir -p $OUTPUT_DIR_PDF
|
|
poetry run pdoc3 --pdf src.concrete.ml > tmp.pdoc.output.txt 2>/dev/null
|
|
|
|
# Problems of version
|
|
PANDOC_VERSION_IS_NOT_2=$(pandoc --version | grep "pandoc 2." > /dev/null; echo $?)
|
|
|
|
if [ "$PANDOC_VERSION_IS_NOT_2" -eq 0 ]
|
|
then
|
|
ENGINE="--pdf-engine"
|
|
else
|
|
ENGINE="--latex-engine"
|
|
fi
|
|
|
|
pandoc --metadata=title:"TorusML API Documentation" \
|
|
--toc --toc-depth=4 --from=markdown+abbreviations \
|
|
$ENGINE=xelatex \
|
|
--output=$OUTPUT_DIR_PDF/pdoc.pdf tmp.pdoc.output.txt
|
|
|
|
rm -f tmp.pdoc.output.txt
|
|
|
|
echo "Documentation created."
|
|
echo "Please open '$OUTPUT_DIR_PDF/pdoc.pdf' for pdf."
|
|
|
|
if [ $OPEN_PDF -eq 1 ]
|
|
then
|
|
open $OUTPUT_DIR_PDF/pdoc.pdf
|
|
fi
|
|
|
|
echo "Successful end" |