update docs

richecr · Jun 19, 2020 · b4719b0 · b4719b0
1 parent 5d69338
commit b4719b0
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 38 deletions.
diff --git a/docs/geoparsing/introdution.md b/docs/geoparsing/introdution.md
@@ -1,10 +1,10 @@
 # Introdução
 
-PyElit é uma biblioteca desenvolvida para ser utilizada em um projeto de pesquisa no [LSI-UFCG](https://sites.google.com/view/lsi-ufcg). Entretanto, foi decidido que seria melhor disponibilizar para a comunidade, assim permitindo que outros desenvolvedores possam contribuir para melhorar a biblioteca, seja com novas funcionalidades, melhorias, mostrando BUGs e etc.
+PyElit é uma biblioteca que permite realizar o geoparsing de um certo texto. Por enquanto não é possível treinar com um gazetteer passado, mas isso está com futuras funcionalidades da biblioteca.
 
 ## Objetivo
 
-A biblioteca tem como objetivo realizar o Geoparsing de textos, permitindo que seja utilizados gazetteer para melhorar as buscas, atualmente só tem o gazetteer de algumas regiões do estado da Paraíba, em grande parte nas cidades de: Campina Grande e João Pessoa.
+A biblioteca tem como um dos objetivos realizar o Geoparsing de textos, permitindo que seja utilizados gazetteer para melhorar as buscas, atualmente só tem o gazetteer de algumas regiões do estado da Paraíba, em grande parte nas cidades de: Campina Grande e João Pessoa.
 
 E também tem como objetivo realizar a classificação de textos que envolvam certos tipos de problemas urbanos. Futuramente poderiamos permitir que o usuário da biblioteca forneça os textos para que então realizassemos o tratamento e a geração de tópicos.
 

diff --git a/docs/index.md b/docs/index.md
@@ -6,41 +6,46 @@
 - [TopicModeling](#topicmodeling)
 
 ## O que é PyElit ?
-PyElit, Extraction of Locations and Issues of a Text, é uma biblioteca open-source gratuita para realização de Geoparsing e Modelagem de Tópicos desenvolvida em Python.
 
-Você trabalha com muitos textos ? Quer extrair localizações ?
-Quer saber qual o problema urbano trata o seu texto ?
+PyElit, Extraction of Locations and Issues of a Text, é uma biblioteca open-source para realização de Geoparsing e Modelagem de Tópicos desenvolvida em Python. É uma biblioteca desenvolvida para ser utilizada em um projeto de pesquisa no [Laboratório de Sistemas da Informação - UFCG](https://sites.google.com/view/lsi-ufcg). Entretanto foi decidido que seria melhor disponibilizar para a comunidade, assim permitindo que outros desenvolvedores possam contribuir para melhorar a biblioteca, seja com novas funcionalidades, melhorias, mostrando BUGs e etc.
 
-O PyElit foi criado especialmente para isso. Com ele é possível extrair localizações e classificar textos que em tópicos de problemas urbanos. No inicio, a biblioteca seria usada para um projeto que necessita de saídas como essas extração de localidades e a classificação dos textos em problemas urbanos. Pesquisa realizada no [Laboratório de Sistemas da Informação - UFCG](https://sites.google.com/view/lsi-ufcg).
+Você trabalha com muitos textos ? Quer extrair localizações ? Quer saber qual problema urbano é tratado no seu texto ?
 
-Entretanto, foi decidido que a biblioteca seria disponibilizada para a comunidade. Sabemos que a biblioteca não é capaz de resolver todos os problemas, mas foi útil para o projeto que iniciou sua criação. Portanto, permitimos que os usuários da biblioteca possam fazer alterações no código fonte, adaptando ao seu problema para então obter melhores resultados em suas pesquisas, assim contribuindo para um maior número de pessoas.
+PyElit tem como um dos objetivos realizar o Geoparsing de textos, permitindo que seja utilizados gazetteer para melhorar as buscas, atualmente só tem o gazetteer de algumas regiões do estado da Paraíba, em grande parte nas cidades de: Campina Grande e João Pessoa.
+
+E também tem como objetivo realizar a classificação de textos que envolvam certos tipos de problemas urbanos. Futuramente poderiamos permitir que os usuários da biblioteca forneça os textos para que então realizassemos o tratamento e a geração de tópicos.
+
+Sabemos que a biblioteca não é capaz de resolver todos os problemas, mas foi útil para o projeto que deu inicio a sua criação. Portanto permitimos que os usuários da biblioteca possam fazer alterações no código fonte, adaptando ao seu problema para então obter melhores resultados em suas pesquisas, assim a biblioteca poderá ser útil para um maior número de pessoas.
 
 E assim os usuários que conseguirem fazer melhorias poderia enviar PRs para o aprimoramento da biblioteca.
 
 ## Funcionalidades:
-|  Funcionalidade  |  Descrição  |
-|  --------------  |  ---------  |
-|  Geoparsing      |  Permite extrair localizações de um texto qualquer.  |
-|  TopicModeling   |  Permite classificar um dado texto para um determinado tópico de problemas urbanos  |
+
+| Funcionalidade | Descrição                                                                         |
+| -------------- | --------------------------------------------------------------------------------- |
+| Geoparsing     | Permite extrair localizações de um texto qualquer.                                |
+| TopicModeling  | Permite classificar um dado texto para um determinado tópico de problemas urbanos |
 
 ## Geoparsing
-Detalhes de como funciona e como usar o Geoparsing da biblioteca.
+
+Detalhes de como funciona o Geoparsing da biblioteca.
 
 - [Introdução](geoparsing/introdution.md)
-    - [Objetivo](geoparsing/introdution.md#objetivo)
+  - [Objetivo](geoparsing/introdution.md#objetivo)
 - [Como usar ?](geoparsing/introdution.md#como-usar-)
-    - [Geoparsing em texto com case correto](geoparsing/introdution.md#geoparsing-com-case-correto-sem-utilização-do-gazetteer)
-    - [Geoparsing em texto com case incorreto](geoparsing/introdution.md#geoparsing-com-case-incorreto-sem-utilização-do-gazetteer)
-    - [Geoparsing com o gazetteer(disponibilizado pela própria biblioteca)](geoparsing/introdution.md#geoparsing-com-gazetteer)
+  - [Geoparsing em texto com case correto](geoparsing/introdution.md#geoparsing-com-case-correto-sem-utilização-do-gazetteer)
+  - [Geoparsing em texto com case incorreto](geoparsing/introdution.md#geoparsing-com-case-incorreto-sem-utilização-do-gazetteer)
+  - [Geoparsing com o gazetteer(disponibilizado pela própria biblioteca)](geoparsing/introdution.md#geoparsing-com-gazetteer)
 
 ## TopicModeling
-Detalhes de como funciona e como usar o TopicModeling da biblioteca
+
+Detalhes de como funciona o TopicModeling da biblioteca
 
 - [Introdução](topic_modeling/introdution.md#introdução)
-    - [Objetivo](topic_modeling/introdution.md#objetivo)
+  - [Objetivo](topic_modeling/introdution.md#objetivo)
 - [Como usar ?](topic_modeling/introdution.md#como-usar-)
-    - [Classificar um texto](topic_modeling/introdution.md#topicmodeling-classificar-um-texto)
-    - [Imrpimir tópicos](topic_modeling/introdution.md#topicmodeling-imprimir-tópicos)
-    - [Imprimir palavras chaves dos tópicos](topic_modeling/introdution.md#topicmodeling-imprimir-palavras-chaves-e-seus-pesos-em-cada-tópico)
-    - [Representatividade do nome dos tópicos](topic_modeling/introdution.md#topicmodeling-mudar-representatividade-do-nomes-dos-tópicos)
-    - [Imprimir tópico pelo ID](topic_modeling/introdution.md#topicmodeling-imprimir-um-tópico-por-meio-do-id-dele)
+  - [Classificar um texto](topic_modeling/introdution.md#topicmodeling-classificar-um-texto)
+  - [Imrpimir tópicos](topic_modeling/introdution.md#topicmodeling-imprimir-tópicos)
+  - [Imprimir palavras chaves dos tópicos](topic_modeling/introdution.md#topicmodeling-imprimir-palavras-chaves-e-seus-pesos-em-cada-tópico)
+  - [Representatividade do nome dos tópicos](topic_modeling/introdution.md#topicmodeling-mudar-representatividade-do-nomes-dos-tópicos)
+  - [Imprimir tópico pelo ID](topic_modeling/introdution.md#topicmodeling-imprimir-um-tópico-por-meio-do-id-dele)
diff --git a/docs/topic_modeling/introdution.md b/docs/topic_modeling/introdution.md
@@ -1,10 +1,10 @@
 # Introdução
 
-PyElit também é uma biblioteca que permite classificar textos que tratem de problemas urbanos. Por enquanto não é possível treinar seus próprios dados.
+PyElit também é uma biblioteca que permite classificar textos que tratem de problemas urbanos. Por enquanto não é possível treinar o modelo com seus próprios dados.
 
 ## Objetivo
 
-O módulo tem como objetivo classificar um texto em um dos problemas urbanos treinados no modelo: saneamento, trânsito, obras e diversos. O modelo foi treinado com reportagens do quadro de televisão: Calendário JPB do telejornal JPB da TV Cabo Branco.
+O módulo tem como objetivo classificar um texto em um dos problemas urbanos treinados no modelo: saneamento básico, trânsito, obras e diversos. O modelo foi treinado com reportagens do quadro de televisão: Calendário JPB do telejornal JPB da TV Cabo Branco afiliada da Rede Globo.
 
 Permite também a visualização de documentos de textos daquele tópico, permite que vejamos as palavras chaves de um determinado tópico.
 
@@ -17,11 +17,11 @@ Vamos ver alguns exemplos de como usar:
 ## TopicModeling: Classificar um texto
 
 ```python
-m = TopicModeling()
-r = m.rate_text("o ginásio da Escola Maria Honoriana Santiago está com obras paradas desde do início do ano.")
+topicModeling = TopicModeling()
+result = topicModeling.rate_text("o ginásio da Escola Maria Honoriana Santiago está com obras paradas desde do início do ano.")
 
-print("Tópicos e probabilidades:", r)
-print("Tópico:", m.get_topic(r[0][0]))
+print("Tópicos e probabilidades:", result)
+print("Tópico:", topicModeling.get_topic(r[0][0]))
 ```
 
 Saídas para esse exemplo:
@@ -34,8 +34,8 @@ Tópico: obras
 ## TopicModeling: Imprimir tópicos
 
 ```python
-m = TopicModeling()
-print(m.print_topics())
+topicModeling = TopicModeling()
+print(topicModeling.print_topics())
 ```
 
 Saída para esse exemplo:
@@ -47,9 +47,9 @@ Saída para esse exemplo:
 ## TopicModeling: Imprimir palavras chaves e seus pesos em cada tópico
 
 ```python
-m = TopicModeling()
+topicModeling = TopicModeling()
 
-print(m.print_keywords(quant_max_palavras=2))
+print(topicModeling.print_keywords(quant_max_palavras=2))
 ```
 
 Saída para esse exemplo:
@@ -61,10 +61,10 @@ Saída para esse exemplo:
 ## TopicModeling: Mudar representatividade do nomes dos tópicos
 
 ```python
-m = TopicModeling()
+topicModeling = TopicModeling()
 
-m.represent_topics([0, 1, 2, 3], ['Saneamento', 'Trânsito','Obras', 'Diversos'])
-print(m.print_topics())
+topicModeling.represent_topics([0, 1, 2, 3], ['Saneamento', 'Trânsito','Obras', 'Diversos'])
+print(topicModeling.print_topics())
 ```
 
 Saída para esse exemplo:
@@ -76,9 +76,9 @@ Saída para esse exemplo:
 ## TopicModeling: Imprimir um tópico por meio do id dele
 
 ```python
-m = TopicModeling()
+topicModeling = TopicModeling()
 
-print(m.get_topic(id_topic=1))
+print(topicModeling.get_topic(id_topic=1))
 ```
 
 Saída para esse exemplo: