Skip to content

Update tutorial_P3_transfer_learning #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
VivianChencwy wants to merge 1 commit into from
Closed

Update tutorial_P3_transfer_learning #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 51 additions & 51 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
# Minimal makefile for Sphinx documentation
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
PKG ?= eegdash
APIDIR := $(SOURCEDIR)/api

help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: apidoc
apidoc:
# Generate full API docs, then prune duplicates covered by autosummary
@rm -f "$(APIDIR)"/dataset/eegdash.features*
@SPHINX_APIDOC_OPTIONS=members,undoc-members,show-inheritance,noindex \
python -m sphinx.ext.apidoc -f -e -T -o "$(APIDIR)/dataset" "../$(PKG)" "../$(PKG)/features"


# Standard build runs examples
html: apidoc

# Fast build: do NOT execute examples (sphinx-gallery)
.PHONY: html-noplot
html-noplot: apidoc
@python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" \
$(SPHINXOPTS) -D sphinx_gallery_conf.plot_gallery=0 $(O)

# Custom clean target to remove generated API docs and build files
.PHONY: clean
clean:
@echo "Removing generated API documentation..."
@rm -rf "$(APIDIR)/dataset"
@rm -rf "$(APIDIR)/generated"
@echo "Removing generated dataset pages..."
@rm -rf "$(APIDIR)/datasets"
@rm -f "$(APIDIR)/api_dataset.rst"
@echo "Removing other generated directories..."
@rm -rf "$(SOURCEDIR)/generated"
@rm -rf "$(SOURCEDIR)/gen_modules"
@echo "Removing build directory..."
@rm -rf "$(BUILDDIR)"
@echo "Clean completed."

.PHONY: help apidoc
Makefile: ;

%: Makefile
@python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Minimal makefile for Sphinx documentation
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
PKG ?= eegdash
APIDIR := $(SOURCEDIR)/api
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: apidoc
apidoc:
# Generate full API docs, then prune duplicates covered by autosummary
@rm -f "$(APIDIR)"/dataset/eegdash.features*
@SPHINX_APIDOC_OPTIONS=members,undoc-members,show-inheritance,noindex \
python -m sphinx.ext.apidoc -f -e -T -o "$(APIDIR)/dataset" "../$(PKG)" "../$(PKG)/features"
# Standard build runs examples
html: apidoc
# Fast build: do NOT execute examples (sphinx-gallery)
.PHONY: html-noplot
html-noplot: apidoc
@python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" \
$(SPHINXOPTS) -D sphinx_gallery_conf.plot_gallery=0 $(O)
# Custom clean target to remove generated API docs and build files
.PHONY: clean
clean:
@echo "Removing generated API documentation..."
@rm -rf "$(APIDIR)/dataset"
@rm -rf "$(APIDIR)/generated"
@echo "Removing generated dataset pages..."
@rm -rf "$(APIDIR)/datasets"
@rm -f "$(APIDIR)/api_dataset.rst"
@echo "Removing other generated directories..."
@rm -rf "$(SOURCEDIR)/generated"
@rm -rf "$(SOURCEDIR)/gen_modules"
@echo "Removing build directory..."
@rm -rf "$(BUILDDIR)"
@echo "Clean completed."
.PHONY: help apidoc
Makefile: ;
%: Makefile
@python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
38 changes: 19 additions & 19 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Install

```
pip install -e ".[docs]"
```

# Build

```
cd docs
make build
```

# Run and update in real time

```
sphinx-autobuild docs docs/_build/html
```

# Install
```
pip install -e ".[docs]"
```
# Build
```
cd docs
make build
```
# Run and update in real time
```
sphinx-autobuild docs docs/_build/html
```
28 changes: 14 additions & 14 deletions docs/plot_dataset/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
"""Plot generation utilities for EEGDash documentation."""

from .bubble import generate_dataset_bubble # noqa: F401
from .colours import ( # noqa: F401
CANONICAL_MAP,
COLUMN_COLOR_MAPS,
MODALITY_COLOR_MAP,
PATHOLOGY_COLOR_MAP,
TYPE_COLOR_MAP,
hex_to_rgba,
)
from .plot_sankey import generate_dataset_sankey # noqa: F401
from .ridgeline import generate_modality_ridgeline # noqa: F401
from .treemap import generate_dataset_treemap # noqa: F401
"""Plot generation utilities for EEGDash documentation."""
from .bubble import generate_dataset_bubble # noqa: F401
from .colours import ( # noqa: F401
CANONICAL_MAP,
COLUMN_COLOR_MAPS,
MODALITY_COLOR_MAP,
PATHOLOGY_COLOR_MAP,
TYPE_COLOR_MAP,
hex_to_rgba,
)
from .plot_sankey import generate_dataset_sankey # noqa: F401
from .ridgeline import generate_modality_ridgeline # noqa: F401
from .treemap import generate_dataset_treemap # noqa: F401
Loading