Skip to content

Commit

Permalink
Add extractor type READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubklimek committed Jan 5, 2021
1 parent f5bb544 commit cd4275e
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 9 deletions.
4 changes: 2 additions & 2 deletions extractors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ An extractor is a component which performs an operation of extracting data from
The folder is structured according to extractor types:

- [Extract external knowledge](extract-external-knowledge)
- [Extract metadata](extract-metadata-descriptor)
- Extract content (empty at the moment)
- [Extract metadata descriptor](extract-metadata-descriptor)
- [Extract content descriptor](extract-content-descriptor) (empty at the moment)
6 changes: 6 additions & 0 deletions extractors/extract-content-descriptor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Extract content descriptor
*Extract content descriptor* represents a component performing

<code><i>extract</i><sub><i>desc</i></sub>(DatasetSource,Metadata<sup>+</sup>): Descriptor<sup>+</sup></code>

which extracts from a dataset source a descriptor for each dataset with a provided metadata descriptor.
8 changes: 6 additions & 2 deletions extractors/extract-external-knowledge/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
# Knowledge graph extractors
Knowledge graph extractors are components, which ...
# Extract external knowledge
*Extract external knowledge* represents a component performing

<code><i>extract</i><sub><i>k</i></sub>(KnowledgeSource): Knowledge<sup>*</sup></code>

which extracts an external knowledge from a given external knowledge source.
8 changes: 6 additions & 2 deletions extractors/extract-metadata-descriptor/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
# Metadata extractors
Metadata extractors are components, which ...
# Extract metadata descriptor
*Extract metadata descriptor* represents a component performing

<code><i>extract</i><sub><i>meta</i></sub>(DataCatalogSource): Metadata<sup>+</sup></code>

which extracts metadata about datasets from a given data catalog source.
4 changes: 3 additions & 1 deletion presenters/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ A presenter is a component which uses the products of dataset similarity pipelin

The folder is structured according to presenter types:

(Empty)
- [Similarity evaluation](similarity-evaluation) (empty at the moment)
- [Similarity explanation](similarity-explanation) (empty at the moment)
- [Similarity search](similarity-search) (empty at the moment)
4 changes: 2 additions & 2 deletions processors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ A processor is a component which performs an operaton for processing input entit

The folder is structured according to processor types:
- [Refine descriptor](refine-descriptor)
- Refine external knowledge (empty at the moment)
- [Refine external knowledge](refine-external-knowledge) (empty at the moment)
- [Refine mapping](refine-mapping)
- [Compute similarities](compute-similarities)
- Multimodal fusion (empty at the moment)
- [Fuse similarities](fuse-similarities) (empty at the moment)
- [Map dataset to knowledge](map-dataset-to-knowledge)

0 comments on commit cd4275e

Please sign in to comment.