Add CLI and prepare for future AI features

Author: YoanSallami

.gitignore

@@ -1,6 +1,3 @@
-# mlflow files
-mlruns/
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -57,13 +57,13 @@ Synalinks can help you simplify these tasks by leveraging decade old practices i
 ## Install
 
 ```shell
-pip install synalinks
+uv pip install synalinks
 ```
 
-or (recommended)
+Start your project with
 
 ```shell
-uv pip install synalinks
+uv run synalinks init
 ```
 
 ## Programming your application: 4 ways

coverage-badge.svg

@@ -1,2 +1,4 @@
 
+::: synalinks.src.backend.common.global_state
+
 ::: synalinks.src.backend.config

docs/Synalinks API/Config.md

@@ -3,13 +3,13 @@
 ## Install
 
 ```shell
-pip install synalinks
+uv pip install synalinks
 ```
 
-or (recommended)
+Start your project with
 
 ```shell
-uv pip install synalinks
+uv run synalinks init
 ```
 
 ## Programming your application: 4 ways

docs/index.md

@@ -0,0 +1,13 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Environment variables
+.env

my-project/.gitignore

@@ -0,0 +1,11 @@
+FROM python:3.13
+
+COPY ./requirements.txt ./requirements.txt
+
+RUN apt update && apt install -y graphviz
+
+RUN pip install --no-cache-dir --upgrade -r ./requirements.txt
+
+COPY . ./
+
+CMD ["fastapi", "run", "my_project/src/main.py", "--host", "0.0.0.0", "--port", "8000"]

my-project/Dockerfile

@@ -0,0 +1,45 @@
+# my-project
+## My awesome project
+
+[my-project](my-project.png)
+
+# Install dependencies
+
+To plot your programs, you will need graphviz
+
+```shell
+sudo apt update
+sudo apt install graphviz
+```
+
+# Install your project as a library
+
+```shell
+cd my-project
+uv venv
+uv pip install .
+```
+
+# Train your application
+
+```shell
+cd my-project
+python3 scripts/train.py
+```
+
+# Serve your API
+
+```shell
+cd my-project
+docker compose up
+```
+
+Powered by [🧠🔗 - synalinks](https://github.com/SynaLinks/synalinks)
+
+More information available in the [documentation](https://synalinks.github.io/synalinks/)
+
+If you have questions, check out [FAQ](https://synalinks.github.io/synalinks/FAQ/).
+
+Join our [Discord](https://discord.gg/82nt97uXcM) to never miss any update!
+
+Happy coding 😀!

my-project/README.md

@@ -0,0 +1 @@
+Here lies your custom datasets

my-project/datasets/README.md

@@ -0,0 +1,101 @@
+[
+    {
+        "query": "What are the fundamental principles of quantum mechanics, and how do they differ from classical physics?"
+    },
+    {
+        "query": "Analyze the impact of the Industrial Revolution on global economic development."
+    },
+    {
+        "query": "Explain the theory of relativity and its implications for our understanding of space and time."
+    },
+    {
+        "query": "Discuss the role of the unconscious mind in Freudian psychoanalysis."
+    },
+    {
+        "query": "Compare and contrast the political philosophies of John Locke and Thomas Hobbes."
+    },
+    {
+        "query": "What are the primary causes of climate change, and what are the most effective strategies for mitigation?"
+    },
+    {
+        "query": "Explain the significance of the double helix structure of DNA in genetics."
+    },
+    {
+        "query": "Analyze the economic theories of Karl Marx and their influence on modern economics."
+    },
+    {
+        "query": "Discuss the ethical considerations surrounding genetic engineering and designer babies."
+    },
+    {
+        "query": "What are black holes, and how do they form and evolve in the universe?"
+    },
+    {
+        "query": "Explain the concept of cultural hegemony and its role in shaping societal norms."
+    },
+    {
+        "query": "Compare and contrast the artistic movements of Surrealism and Dadaism."
+    },
+    {
+        "query": "What are the challenges and opportunities presented by renewable energy sources?"
+    },
+    {
+        "query": "Discuss the impact of colonialism on the cultural identity of colonized nations."
+    },
+    {
+        "query": "Explain the process of photosynthesis and its importance in the ecosystem."
+    },
+    {
+        "query": "Analyze the influence of the Renaissance on the development of Western art and science."
+    },
+    {
+        "query": "What are the key differences between qualitative and quantitative research methods?"
+    },
+    {
+        "query": "Discuss the role of artificial intelligence in transforming modern healthcare."
+    },
+    {
+        "query": "Explain the concept of entropy and its significance in thermodynamics."
+    },
+    {
+        "query": "Analyze the factors contributing to the rise and fall of the Roman Empire."
+    },
+    {
+        "query": "What are the implications of the butterfly effect in chaos theory?"
+    },
+    {
+        "query": "Discuss the impact of globalization on local cultures and economies."
+    },
+    {
+        "query": "Explain the principles of evolution by natural selection and their evidence in the fossil record."
+    },
+    {
+        "query": "Analyze the significance of the French New Wave in cinema history."
+    },
+    {
+        "query": "What are the ethical considerations in the development and use of autonomous weapons?"
+    },
+    {
+        "query": "Discuss the role of the media in shaping public opinion and political discourse."
+    },
+    {
+        "query": "Explain the concept of the singularity in the context of artificial intelligence."
+    },
+    {
+        "query": "Analyze the impact of the internet on social interactions and community formation."
+    },
+    {
+        "query": "What are the challenges in achieving sustainable agriculture practices?"
+    },
+    {
+        "query": "Discuss the significance of the Human Genome Project in medical research."
+    },
+    {
+        "query": "Explain the principles of game theory and their applications in economics and politics."
+    },
+    {
+        "query": "Analyze the role of women in the workforce during World War II and its lasting effects."
+    },
+    {
+        "query": "What are the implications of the observer effect in quantum mechanics?"
+    }
+]