Mentions légales du service
Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
declearn2
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Magnet
DecLearn
declearn2
Commits
542f5ad8
Verified
Commit
542f5ad8
authored
1 year ago
by
ANDREY Paul
Browse files
Options
Downloads
Patches
Plain Diff
Fix docs' automated rendering.
parent
6300a10e
No related branches found
No related tags found
1 merge request
!63
Finalize DecLearn v2.4.0.
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
.gitignore
+2
-1
2 additions, 1 deletion
.gitignore
declearn/metrics/__init__.py
+1
-1
1 addition, 1 deletion
declearn/metrics/__init__.py
scripts/gen_docs.py
+3
-0
3 additions, 0 deletions
scripts/gen_docs.py
with
6 additions
and
2 deletions
.gitignore
+
2
−
1
View file @
542f5ad8
...
@@ -17,9 +17,10 @@ coverage.xml
...
@@ -17,9 +17,10 @@ coverage.xml
examples/*/*.csv
examples/*/*.csv
examples/*/*.pem
examples/*/*.pem
examples/*/*/
examples/*/*/
# Documentation
online
render
ing
files.
# Documentation render
ed
files.
public/
public/
site/
site/
docs/api-reference/*/
docs/api-reference/*/
docs/api-reference/SUMMARY.md
docs/api-reference/SUMMARY.md
docs/api-reference/typing.md
docs/api-reference/typing.md
docs/api-reference/version.md
This diff is collapsed.
Click to expand it.
declearn/metrics/__init__.py
+
1
−
1
View file @
542f5ad8
...
@@ -25,7 +25,7 @@ Abstractions
...
@@ -25,7 +25,7 @@ Abstractions
------------
------------
* [Metric][declearn.metrics.Metric]:
* [Metric][declearn.metrics.Metric]:
Abstract base class defining an API for metrics
'
computation.
Abstract base class defining an API for metrics
'
computation.
* [MetricState][declearn.metric.MetricState]:
* [MetricState][declearn.metric
s
.MetricState]:
Abstract base class for Metrics intermediate aggregatable states.
Abstract base class for Metrics intermediate aggregatable states.
* [MeanMetric][declearn.metrics.MeanMetric]:
* [MeanMetric][declearn.metrics.MeanMetric]:
Abstract class that defines a template for simple scores
'
averaging.
Abstract class that defines a template for simple scores
'
averaging.
...
...
This diff is collapsed.
Click to expand it.
scripts/gen_docs.py
+
3
−
0
View file @
542f5ad8
...
@@ -151,6 +151,9 @@ def _generate_public_submodules_doc(
...
@@ -151,6 +151,9 @@ def _generate_public_submodules_doc(
pub_mod
=
{}
pub_mod
=
{}
for
key
,
mod
in
module
.
modules
.
items
():
for
key
,
mod
in
module
.
modules
.
items
():
if
not
key
.
startswith
(
"
_
"
):
if
not
key
.
startswith
(
"
_
"
):
if
isinstance
(
mod
,
griffe
.
dataclasses
.
Alias
):
key
=
f
"
{
key
}
(alias re-export)
"
mod
=
mod
.
target
pub_mod
[
key
]
=
generate_module_docs
(
mod
,
docdir
)
pub_mod
[
key
]
=
generate_module_docs
(
mod
,
docdir
)
return
pub_mod
return
pub_mod
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment