Skip to content

Commit

Permalink
chore(docs): readme update [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoDelatte committed Dec 31, 2023
1 parent de262c5 commit 23f5d5c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@

**skfolio** is a Python library for portfolio optimization built on top of scikit-learn.
It offers a unified interface and tools compatible with scikit-learn to build, fine-tune,
and cross-validate portfolio models. It is distributed under the open source 3-Clause
BSD license.
and cross-validate portfolio models.

It is distributed under the open source 3-Clause BSD license.

.. image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/expo.jpg
:target: https://skfolio.org/auto_examples/
Expand All @@ -69,7 +70,7 @@ Installation
Dependencies
~~~~~~~~~~~~

skfolio requires:
`skfolio` requires:

- python (>= |PythonMinVersion|)
- numpy (>= |NumpyMinVersion|)
Expand Down Expand Up @@ -544,7 +545,7 @@ If you use `skfolio` in a scientific publication, we would appreciate citations:
Bibtex entry::
@misc{riskfolio,
@misc{skfolio,
author = {Hugo Delatte},
title = {skfolio},
year = {2023},
Expand Down
9 changes: 5 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ skfolio

**skfolio** is a Python library for portfolio optimization built on top of scikit-learn.
It offers a unified interface and tools compatible with scikit-learn to build, fine-tune,
and cross-validate portfolio models. It is distributed under the open source 3-Clause
BSD license.
and cross-validate portfolio models.

It is distributed under the open source 3-Clause BSD license.

.. image:: _static/expo.jpg
:target: https://skfolio.org/auto_examples/
Expand Down Expand Up @@ -484,11 +485,11 @@ source of inspiration:
Citation
~~~~~~~~
If you use skfolio in a scientific publication, we would appreciate citations:
If you use `skfolio` in a scientific publication, we would appreciate citations:
Bibtex entry::
@misc{riskfolio,
@misc{skfolio,
author = {Hugo Delatte},
title = {skfolio},
year = {2023},
Expand Down

0 comments on commit 23f5d5c

Please sign in to comment.