diff --git a/docs/0. Overview/0.0. Course.md b/docs/0. Overview/0.0. Course.md index d037dc4..d41ee47 100644 --- a/docs/0. Overview/0.0. Course.md +++ b/docs/0. Overview/0.0. Course.md @@ -1,17 +1,13 @@ # 0.0. Course -## In few words +## What is this course about? +## How much does this course cost? -## Intended Audience +## Why should I pursue this course? -## Prerequisites knowledge +## What are the course prerequisites? +## What will I learn with this course? -## How to read ? - - -## Technology - - -Copyright \ No newline at end of file +## How much time does this course take to complete? \ No newline at end of file diff --git a/docs/0. Overview/0.1. Projects.md b/docs/0. Overview/0.1. Projects.md index 984bbd0..5a22e8b 100644 --- a/docs/0. Overview/0.1. Projects.md +++ b/docs/0. Overview/0.1. Projects.md @@ -1 +1,9 @@ -# 0.1. Projects \ No newline at end of file +# 0.1. Projects + +## What is the course default project? + +## Can I use my own project instead? + +## Where can I get inspiration? + +## Can I do an LLM project? \ No newline at end of file diff --git a/docs/0. Overview/0.2. Datasets.md b/docs/0. Overview/0.2. Datasets.md index 64b53f9..f92f4fd 100644 --- a/docs/0. Overview/0.2. Datasets.md +++ b/docs/0. Overview/0.2. Datasets.md @@ -2,7 +2,11 @@ Data is often referred to as the fuel for Machine Learning, and although this course focuses on MLOps, it's crucial to have access to data to fully grasp the various concepts and technologies involved. -## Types of Data +## What is a dataset? + +## Why do I need a dataset? + +## What are the types of dataset? When mentionning data, the first point is perhaps what are we talking about. When exploiting the model, data will be required at every step and will take many forms, be stored on different supports and will have different properties. @@ -29,8 +33,8 @@ Structured data adheres to a predefined model, making it easier to search and or * useful to model complex networks and many real workd syste,s * graph can be directed, undirected , weighted, multiple, cyclic, acyclic - ### Unstructured Data + Unstructured data does not follow a predefined model, making it more complex to process. * *Text*: @@ -46,9 +50,7 @@ Unstructured data does not follow a predefined model, making it more complex to Data that does not conform to a rigid data model like structured data, but it does contain tags or other markers to separate semantic elements and enforce hierarchies of records and fields, making it easier to parse than unstructured data. Examples are XML and JSON files. - - -## Which data should I use? +## Which dataset should I use? The question of which dataset to use is common, and honestly, the best dataset is the one you're most familiar with. While the vast array of data types and their diverse applications might seem overwhelming, it's important to remember that many MLOps concepts are universal and can be applied across different domains. diff --git a/docs/0. Overview/0.3. Platforms.md b/docs/0. Overview/0.3. Platforms.md index 185e24c..139710c 100644 --- a/docs/0. Overview/0.3. Platforms.md +++ b/docs/0. Overview/0.3. Platforms.md @@ -1,7 +1,19 @@ # 0.3. Platforms -Databricks, metaflow ... +## What is an MLOps platform? + +## Which MLOps platform is the best? + +## Why you did not choose an MLOps platform? + +Already plently on content, focus on common ground => We want something neutral that can be used on every platform -Other courses will introduce these tools. \ No newline at end of file +Other courses will introduce these tools. + +## Does this course require an MLOps platform? + +## How this course will be beneficial for my MLOps platform? + +Databricks, metaflow ... diff --git a/docs/0. Overview/0.4. Mentoring.md b/docs/0. Overview/0.4. Mentoring.md index c73ac87..88d1a56 100644 --- a/docs/0. Overview/0.4. Mentoring.md +++ b/docs/0. Overview/0.4. Mentoring.md @@ -1,3 +1,13 @@ # 0.4. Mentoring -Mentoring \ No newline at end of file +## Is it possible to receive mentoring? + +Yes + +## How this project mentoring will cost? + +## Is it possible to get a company training? + +## Can I do mentoring services with this course? + +License, attribution \ No newline at end of file diff --git a/docs/0. Overview/0.5. Assistants.md b/docs/0. Overview/0.5. Assistants.md index 7bc3fcb..a3d49c9 100644 --- a/docs/0. Overview/0.5. Assistants.md +++ b/docs/0. Overview/0.5. Assistants.md @@ -1 +1,11 @@ -# 0.5. Assistants \ No newline at end of file +# 0.5. Assistants + +## What is the course assistant? + +Automated agent + +## How does this assistant work? + +## How should I use the assistant? + +## Can I fully trust the assistant? \ No newline at end of file diff --git a/docs/0. Overview/0.6. Resources.md b/docs/0. Overview/0.6. Resources.md index 79f8c9d..d40769f 100644 --- a/docs/0. Overview/0.6. Resources.md +++ b/docs/0. Overview/0.6. Resources.md @@ -1 +1,7 @@ -# 0.6. Resources \ No newline at end of file +# 0.6. Resources + +## Is there additional project resources? + +## Can I suggest a new project resource? + +## Can I contribute to the resources? \ No newline at end of file diff --git a/docs/0. Overview/index.md b/docs/0. Overview/index.md index ec205b9..813dd92 100644 --- a/docs/0. Overview/index.md +++ b/docs/0. Overview/index.md @@ -1 +1,5 @@ -# 0. Overview \ No newline at end of file +# 0. Overview + +This chapter will introduce the course and its content. + +TODO \ No newline at end of file diff --git a/docs/1. Initializing/1.0. System.md b/docs/1. Initializing/1.0. System.md index 63d3f4f..67005e8 100644 --- a/docs/1. Initializing/1.0. System.md +++ b/docs/1. Initializing/1.0. System.md @@ -1 +1,11 @@ -# 1.0. System \ No newline at end of file +# 1.0. System + +## Which system do I need for the course? + +Hardware, OS + +## Do I need to install other software packages? + +## Is there specific requirements for MLOps projects? + +## Can I use a cloud system (e.g., Cloud Workstation, Google Colab, ...)? \ No newline at end of file diff --git a/docs/1. Initializing/1.1. Python.md b/docs/1. Initializing/1.1. Python.md new file mode 100644 index 0000000..8b28365 --- /dev/null +++ b/docs/1. Initializing/1.1. Python.md @@ -0,0 +1,13 @@ +# 1.1. Python + +## What is the Python language? + +## Why most AI/ML projects use Python? + +## Is Python a good or a bad language for MLOps? + +## How easy is it to use another language for AI/ML? + +## Which version of Python should I use to complete the course? + +## How should I install Python on my system to complete the course? \ No newline at end of file diff --git a/docs/1. Initializing/1.2. Python.md b/docs/1. Initializing/1.2. Python.md deleted file mode 100644 index 3e74431..0000000 --- a/docs/1. Initializing/1.2. Python.md +++ /dev/null @@ -1 +0,0 @@ -# 1.2. Python \ No newline at end of file diff --git a/docs/1. Initializing/1.1. pyenv.md b/docs/1. Initializing/1.2. pyenv.md similarity index 84% rename from docs/1. Initializing/1.1. pyenv.md rename to docs/1. Initializing/1.2. pyenv.md index ed13e07..73756bf 100644 --- a/docs/1. Initializing/1.1. pyenv.md +++ b/docs/1. Initializing/1.2. pyenv.md @@ -1,4 +1,4 @@ -# 1.1. pyenv +# 1.2. pyenv ## What is pyenv? @@ -15,11 +15,9 @@ The use of pyenv offers several advantages: For a comprehensive installation guide, visit [Pyenv GitHub Page](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation). It provides detailed instructions tailored for various operating systems. -## Which version of Python should I use for my project? +## Is there a specific setup for MLOps projects? -While using the latest version of Python is generally recommended, for this project, the specified version range is Python 3.12 to 4.0. Ensure compatibility within this range for optimal performance. - -## How to install the version of Python required for my project? +## How to install the required version of Python for my project? To install a specific Python version (e.g., 3.12): ```bash diff --git a/docs/1. Initializing/1.3. Poetry.md b/docs/1. Initializing/1.3. Poetry.md index 82c1f3e..168e8c3 100644 --- a/docs/1. Initializing/1.3. Poetry.md +++ b/docs/1. Initializing/1.3. Poetry.md @@ -1,7 +1,5 @@ # 1.3. Poetry -# 1.3. poetry - ## What is poetry? [Poetry](https://python-poetry.org/) is an innovative package manager for Python, streamlining dependency management and package distribution. It simplifies defining project dependencies and building packages, making it a cornerstone tool for Python project management. @@ -17,7 +15,7 @@ Poetry brings several advantages to your project: - **Package Building and Distribution**: Easily build and share your Python packages with others. - **Project Metadata Definition**: Define essential metadata like authors, URLs, and more in a structured format. -## How can I use poetry for my project? +## How can I use poetry for my MLOps project? To get started with Poetry: - Create a project directory and navigate into it. diff --git a/docs/1. Initializing/1.4. git.md b/docs/1. Initializing/1.4. git.md index efff4fd..1197c3c 100644 --- a/docs/1. Initializing/1.4. git.md +++ b/docs/1. Initializing/1.4. git.md @@ -57,4 +57,8 @@ poetry.lock __pycache__/ ``` -Each line in `.gitignore` specifies a file, folder, or pattern for Git to exclude. \ No newline at end of file +Each line in `.gitignore` specifies a file, folder, or pattern for Git to exclude. + +## Is there specific tips or tricks for MLOps projects? + +Large files \ No newline at end of file diff --git a/docs/1. Initializing/1.5. GitHub.md b/docs/1. Initializing/1.5. GitHub.md index 4189415..d294853 100644 --- a/docs/1. Initializing/1.5. GitHub.md +++ b/docs/1. Initializing/1.5. GitHub.md @@ -10,7 +10,9 @@ GitHub is a versatile choice for hosting both private and open-source projects. - [GitLab](https://about.gitlab.com/): Offers both hosted and self-hosted options with integrated CI/CD features. - [Cloud Source Repositories](https://cloud.google.com/source-repositories/docs): A cloud-based private Git repository service by Google Cloud. -## How to configure GitHub for my project? +## Which services are proposed by Github? + +## How to configure GitHub for my MLOps project? To get started: 1. [Create a GitHub account](https://github.com/join) if you haven't already. @@ -28,4 +30,6 @@ git push origin main Collaboration on GitHub depends on the repository's visibility: - **Public Repositories**: Others can [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) or [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) your project without any special permissions. -- **Private Repositories**: You need to [grant access](https://docs.github.com/en/get-started/learning-about-github/access-permissions-on-github) to collaborators using their GitHub username or email. \ No newline at end of file +- **Private Repositories**: You need to [grant access](https://docs.github.com/en/get-started/learning-about-github/access-permissions-on-github) to collaborators using their GitHub username or email. + +See final section \ No newline at end of file diff --git a/docs/1. Initializing/1.6. VS Code.md b/docs/1. Initializing/1.6. VS Code.md index 8b3dc57..f458e5b 100644 --- a/docs/1. Initializing/1.6. VS Code.md +++ b/docs/1. Initializing/1.6. VS Code.md @@ -1 +1,11 @@ -# 1.6. Visual Studio Code \ No newline at end of file +# 1.6. Visual Studio Code + +## What is VS Code? + +## Why should I use VS Code? + +## Where can I learn to use VS Code? + +## How to configure VS Code for MLOps projects? + +My blog article \ No newline at end of file