Skip to content

Commit 70ba14b

Browse files
author
Yury Kashnitsky
committed
poetry -> uv; remove docker; update deps
1 parent 5f72a0f commit 70ba14b

17 files changed

+2868
-5560
lines changed

.gitattributes

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,3 @@
2222
*.pyo binary
2323

2424
*.ipynb linguist-language=Python
25-
Dockerfile linguist-vendored
26-
docker_files/* linguist-vendored
27-
data/news_data/* linguist-vendored

.pre-commit-config.yaml

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,31 @@ repos:
1212
- id: trailing-whitespace
1313
args: ["--markdown-linebreak-ext=md"]
1414

15+
# Add Ruff for lightning-fast linting and formatting (optional)
16+
- repo: https://github.com/astral-sh/ruff-pre-commit
17+
# Check for the latest tag on GitHub: https://github.com/astral-sh/ruff-pre-commit/releases
18+
rev: v0.4.4
19+
hooks:
20+
# Run the linter.
21+
- id: ruff
22+
args: [--fix, --ignore, E722] # Add --fix to automatically fix issues
23+
# Optional: Uncomment the line below to run the formatter instead of Black
24+
# - id: ruff-format
25+
26+
- repo: https://github.com/pycqa/isort
27+
rev: 5.13.2
28+
hooks:
29+
- id: isort
30+
name: isort (python)
31+
args: ["--profile", "black", "--filter-files"]
32+
1533
# Too much noise from Yaspeller (have to extend the dictionary too often),
1634
# better to run manually from time to time
1735
# `yaspeller -l en mlcourse_ai_jupyter_book/book/`
18-
#
36+
#
1937
# - repo: https://github.com/hcodes/yaspeller.git
2038
# rev: v8.0.0
2139
# hooks:
2240
# - id: yaspeller
2341
# types: [markdown]
24-
# files: \.md$
42+
# files: \.md$

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
Small typos in Jupyter notebooks can be fixed with [Pull Requests](https://github.com/Yorko/mlcourse.ai/pulls), followed by a comment, describing the fix (obligatory).
22

33
If you think, there is a more serious error in course materials (ex. incorrect math designation), you can open an [Issue](https://github.com/Yorko/mlcourse.ai/issues).
4-
5-
If you want to proofread course materials and/or develop new ones (ex. assignments), please contact Yury (@yorko) via [ODS](ods.ai) Slack.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@ The bonus pack contains 10 assignments, in some of them you are challenged to be
104104
2. Predicting popularity of a Medium article. [Kaggle Inclass](https://www.kaggle.com/c/how-good-is-your-medium-article)
105105
3. DotA 2 winner prediction. [Kaggle Inclass](https://www.kaggle.com/c/mlcourse-dota2-win-prediction)
106106

107+
### Building course material as a Jupyter Book
108+
109+
1. Install [uv](https://github.com/astral-sh/uv) for dependency management: `pip install uv`;
110+
1. Run `uv sync` to install project dependencies;
111+
1. Run `uv run jb build mlcourse_ai_jupyter_book` – this will take a while, the output is found in the [mlcourse_ai_jupyter_book/_build](mlcourse_ai_jupyter_book/_build) folder. Namely, [mlcourse_ai_jupyter_book/_build/html/index.html](mlcourse_ai_jupyter_book/_build/html/index.html) is what gets rendered at the [mlcourse.ai](mlcourse.ai) main page.
112+
107113
### Citing mlcourse.ai
108114

109115
If you happen to cite [mlcourse.ai](https://mlcourse.ai) in your work, you can use this BibTeX record:

docker_files/Dockerfile

Lines changed: 0 additions & 74 deletions
This file was deleted.

0 commit comments

Comments
 (0)