Add installation instruction #526

Mr-Geekman · 2022-02-11T14:13:08Z

IMPORTANT: Please do not create a Pull Request without creating an issue first.

Before submitting (must do checklist)

Did you read the contribution guide?
Did you update the docs? We use Numpy format for all the methods and classes.
Did you write any new necessary tests?
Did you update the CHANGELOG?

Type of Change

Examples / docs / tutorials / contributors update
Bug fix (non-breaking change which fixes an issue)
Improvement (non-breaking change which improves an existing feature)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Proposed Changes

Look #490.

Related Issue

#490.

Closing issues

Closes #490.

codecov-commenter · 2022-02-11T14:34:15Z

Codecov Report

Merging #526 (0892c1c) into master (a7a08c8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #526   +/-   ##
=======================================
  Coverage   88.21%   88.21%           
=======================================
  Files         118      118           
  Lines        5677     5677           
=======================================
  Hits         5008     5008           
  Misses        669      669

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a7a08c8...0892c1c. Read the comment docs.

# Conflicts: # CHANGELOG.md

iKintosh

Added some comments. Let's discuss it 🙂

iKintosh · 2022-02-15T18:56:33Z

README.md

 ```bash
 pip install --upgrade pip
 pip install etna
 ```

+Default version hasn't all the dependencies, because some of them are needed only for specific models, e.g. Prophet, PyTorch. 


It's better to say The default version does not contain all the dependencies

iKintosh · 2022-02-15T18:58:13Z

README.md

 ```bash
 pip install --upgrade pip
 pip install etna
 ```

+Default version hasn't all the dependencies, because some of them are needed only for specific models, e.g. Prophet, PyTorch. 
+Available extensions are listed at [`pyproject.toml`](https://github.com/tinkoff-ai/etna/blob/master/pyproject.toml#L93).


It's better to list it right here.

Available extensions are the following: ...

I think it can be difficult to support it after adding new extensions or changing current.

iKintosh · 2022-02-15T18:59:35Z

README.md

+Install extension:
+```bash
+pip install etna[extension-name]
+```


Probably it is better to remove this part, as the all available extensions will be already listed

Even if extensions are listed it can be not obvious how to install them. This instruction makes it clear.

Maybe list extensions as installation instructions:

pip install etna[prophet] pip install etna[torch] pip install etna[wandb]

If you are against it, let's keep it your way.

I think that we should just move information about how to install extensions higher.

iKintosh · 2022-02-15T19:05:12Z

README.md

+
+It can be useful to configure the library to check installed packages during init.
+For example, if you know that you need `Prophet` in you project and don't want to understand that it isn't installed only during the import of `etna.models.ProphetModel`.


Maybe this way it will clearer:

etna supports configuration files. It means that etna will check that all the specified packages are installed prior to script start and NOT during runtime.

iKintosh · 2022-02-15T19:07:43Z

README.md

+It can be useful to configure the library to check installed packages during init.
+For example, if you know that you need `Prophet` in you project and don't want to understand that it isn't installed only during the import of `etna.models.ProphetModel`.
+
+You can create a config file `.etna` at the root of your project, where this checking can be set up. To see the available options look at [`Settings`](https://github.com/tinkoff-ai/etna/blob/master/etna/settings.py#L68). There is an [example](https://github.com/tinkoff-ai/etna/tree/master/examples/configs/.etna) of configuration file. 


Suggested change

You can create a config file `.etna` at the root of your project, where this checking can be set up. To see the available options look at [`Settings`](https://github.com/tinkoff-ai/etna/blob/master/etna/settings.py#L68). There is an [example](https://github.com/tinkoff-ai/etna/tree/master/examples/configs/.etna) of configuration file.

To create a config file you should create `.etna` file at the root of your project. To see the available options look at [`Settings`](https://github.com/tinkoff-ai/etna/blob/master/etna/settings.py#L68). There is an [example](https://github.com/tinkoff-ai/etna/tree/master/examples/configs/.etna) of configuration file.

iKintosh

Looks good to me!

iKintosh · 2022-02-16T12:39:29Z

README.md

+* `torch`
+* `wandb`
+
+There are also developer extensions. All the extensions are listed at [`pyproject.toml`](https://github.com/tinkoff-ai/etna/blob/master/pyproject.toml#L93).


Suggested change

There are also developer extensions. All the extensions are listed at [`pyproject.toml`](https://github.com/tinkoff-ai/etna/blob/master/pyproject.toml#L93).

There are also developer extensions. All the extensions are listed in [`pyproject.toml`](https://github.com/tinkoff-ai/etna/blob/master/pyproject.toml#L93).

iKintosh · 2022-02-16T12:40:11Z

README.md

+Install extension:
+```bash
+pip install etna[extension-name]
+```


If you are against it, let's keep it your way.

iKintosh

🔥

d.a.bunin added 3 commits February 11, 2022 17:11

Add installation instruction

e3834ab

Update changelog

1be40b5

Update command prompts

0c9335f

Mr-Geekman self-assigned this Feb 11, 2022

Mr-Geekman added the documentation Improvements or additions to documentation label Feb 11, 2022

iKintosh requested review from iKintosh and martins0n February 13, 2022 11:30

Merge remote-tracking branch 'origin/master' into issue-490

262f9c7

# Conflicts: # CHANGELOG.md

iKintosh suggested changes Feb 15, 2022

View reviewed changes

Update README.md by comments

0892c1c

Mr-Geekman requested a review from iKintosh February 16, 2022 10:20

iKintosh previously approved these changes Feb 16, 2022

View reviewed changes

Fix installation section

915379b

Mr-Geekman dismissed iKintosh’s stale review via 915379b February 16, 2022 13:12

iKintosh approved these changes Feb 16, 2022

View reviewed changes

Merge remote-tracking branch 'origin/master' into issue-490

83ae3c3

Mr-Geekman merged commit 27acb99 into master Feb 16, 2022

Mr-Geekman deleted the issue-490 branch February 16, 2022 14:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add installation instruction #526

Add installation instruction #526

Mr-Geekman commented Feb 11, 2022 •

edited

Loading

codecov-commenter commented Feb 11, 2022 •

edited

Loading

iKintosh left a comment

iKintosh Feb 15, 2022

iKintosh Feb 15, 2022

Mr-Geekman Feb 16, 2022

iKintosh Feb 15, 2022

Mr-Geekman Feb 16, 2022

iKintosh Feb 16, 2022

iKintosh Feb 16, 2022

Mr-Geekman Feb 16, 2022

iKintosh Feb 15, 2022

iKintosh Feb 15, 2022

iKintosh left a comment

iKintosh Feb 16, 2022

iKintosh Feb 16, 2022

iKintosh left a comment


		It can be useful to configure the library to check installed packages during init.
		For example, if you know that you need `Prophet` in you project and don't want to understand that it isn't installed only during the import of `etna.models.ProphetModel`.

	You can create a config file `.etna` at the root of your project, where this checking can be set up. To see the available options look at [`Settings`](https://github.com/tinkoff-ai/etna/blob/master/etna/settings.py#L68). There is an [example](https://github.com/tinkoff-ai/etna/tree/master/examples/configs/.etna) of configuration file.
	To create a config file you should create `.etna` file at the root of your project. To see the available options look at [`Settings`](https://github.com/tinkoff-ai/etna/blob/master/etna/settings.py#L68). There is an [example](https://github.com/tinkoff-ai/etna/tree/master/examples/configs/.etna) of configuration file.

	There are also developer extensions. All the extensions are listed at [`pyproject.toml`](https://github.com/tinkoff-ai/etna/blob/master/pyproject.toml#L93).
	There are also developer extensions. All the extensions are listed in [`pyproject.toml`](https://github.com/tinkoff-ai/etna/blob/master/pyproject.toml#L93).

Add installation instruction #526

Add installation instruction #526

Conversation

Mr-Geekman commented Feb 11, 2022 • edited Loading

Before submitting (must do checklist)

Type of Change

Proposed Changes

Related Issue

Closing issues

codecov-commenter commented Feb 11, 2022 • edited Loading

Codecov Report

iKintosh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iKintosh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iKintosh left a comment

Choose a reason for hiding this comment

Mr-Geekman commented Feb 11, 2022 •

edited

Loading

codecov-commenter commented Feb 11, 2022 •

edited

Loading