Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vimal-m authored Jan 27, 2022
1 parent e669aa9 commit 49a980a
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ For more use case driven docs, Check the [How-to's](#how-to's) section.

https://user-images.githubusercontent.com/61645553/137438387-690a9d86-cebc-408e-abe5-0e52258b76bd.mp4

## Getting Started
Acharya Docs are available at https://acharya.astutic.com/docs/get-started/acharya-installation

## How to's
1. [Change admin password](#change-admin-password)
Expand All @@ -72,11 +74,11 @@ Based on the format of your data, choose the Data format accordingly. There is a
Data uploaded via upload or command-line tasks are stored as records in Acharya. These records can be viewed and modified on the workbench screen.
The data shown on the workbench screen can be annotated by selecting the data and choosing an appropriate entity.

[Read more about Workbench features](./Pages.md/#workbench)
[Read more about Workbench features](https://acharya.astutic.com/docs/tutorial-basics/using-workbench)

## Dashboard Reports
Acharya project dashboard focuses on data-centric reports about the data in the project.
[See more about the dashboard section](./Pages.md/#dashboard)
[See more about the dashboard section](https://acharya.astutic.com/docs/tutorial-basics/data-centric-reports)

### Check entity data bias from entity distribution
Entity distribution shows how many annotations belongs to each entity. If the number of annotations of a particular entity is less or more as compared to other entities, it shows that the dataset is biased against or towards that entity. This report gives an insight that what kind of new data should be sourced into the project to balance the entity distribution.
Expand Down Expand Up @@ -104,7 +106,7 @@ This table helps in identifying unclassified words in the project. Instead of br
Shows a quick glance of how well each algorithm has been trained on the dataset, and which one is the best trained algorithm.

## Add algorithms
Please read the [Algorithms section](./Pages.md/#algorithms) for detailed information.
Please read the [Algorithms section](https://acharya.astutic.com/docs/get-started/add-algo-to-project) for detailed information.

To add algorithms to the project, the user needs to specify the algorithm details via a yaml configuration.

Expand Down

0 comments on commit 49a980a

Please sign in to comment.