Getting started: Kind of Series (HeroSeries)

[henrifroese]

Only a first draft at the moment; critique welcome (you can have a look at it e.g. by pasting everything in here .

Focus on / extended explanation of Representation Series

Question: Is this the correct location for the file (website/docs/)?

[jbesomi]

Only a first draft at the moment; critique welcome (you can have a look at it e.g. by pasting everything in here.

You can directly add it to the website so that we can see it by clicking "view deployment".

Also, "view file" do the job: view file.

Question: Is this the correct location for the file (website/docs/)?

See #94 for a better contextualization. The idea is to have this file under the "Getting Started" tab.

We might want to call this file: getting-started-heroseries.md

Review:

1. Very good start 💪
2. The style should be aligned somehow with the getting-started document. I would start a bit gently by showing some examples and explain a bit deeper.
3. Before actually writing the content, we can just discuss the structure, the different headings, and sub-headings and the content of each sub-heading, without writing it?

Structure (just a draft)

#HeroSeries

One line intro to give an idea on the subject

Overview

Explain the why
Show the 4

TextSeries

...

TokenSeries

...

RepresentationSeries

...

VectorSeries

• mention better to avoid, used for pca as practical

Open question:

We can have either this page just after the "Getting Started" page or at the end.

Version 1:

1. Getting Started
2. Preprocessing
3. Representation
4. NLP
5. Visualization
6. HeroSeries

Version 2:

1. Getting Started
2. HeroSeries
3. Preprocessing
4. Representation
5. NLP
6. Visualization

We should consider which solution works best, particularly taking into consideration the content of the other pages.

The advantage of Version 1 is that the user understand immediately what HeroSeries are and stand for.

Advantage of Version 2 is that the user got to see the whole pipeline in the details and he should be more aware of the difference between the Series. On the other hand, it's also true that the "1. Getting Started" already provides a general introduction to the pipeline.

Long story short, we need to have clear in mind the aim of this documentation page as well as how it will interface with the rest of the documentation. The idea again here is to provide a simple and unified view of Texthero.

I believe we can aim toward a results similar to the docusaurus documentation: doc.

Extra:

• We need to explain clearly that these are just Pandas Series, nothing else

[henrifroese]

Advantage of Version 2 is that the user got to see the whole pipeline in the details and he should be more aware of the difference between the Series. On the other hand, it's also true that the "1. Getting Started" already provides a general introduction to the pipeline.

We agree with this. Getting started provides an overview, then we have a deep-dive for the users really interested in the different modules through Preprocessing, Representation, NLP, Visualization; and if they still want to know more, they get to the HeroSeries stuff. I think many users will read the getting started, and then later on when googling they will land on texthero.org and then see the TextSeries, RepresentationSeries, ... in the docstrings. This will lead them to the tutorial too as we'll link it in the docstrings!

Also, we just improved the content / explained in more detail, and changed to your proposed structure.