aboutsummaryrefslogtreecommitdiffstats
path: root/doc/source/index.rst
blob: 9cf06fe38a0e193a214496b9975acef34e472955 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

Black Star Information Extraction
=================================

A major advantage of the `Black Star File System (BSFS) <https://www.bsfs.io/bsfs/>`_
is its ability to store various kinds of (meta)data associated with a file.
However, the BSFS itself is only a storage solution,
it does not inspect files or collect information about them.

The Black Star Information Extraction (BSIE) package fills this gap by
extracting various kinds of information from a file and pushing that data to a BSFS instance.

BSIE has the ability to process numerous file formats,
and it can turn various aspects of a file into usable information.
This includes metadata from a source file system,
metadata stored within the file,
and even excerpts or feature representations of the file's content itself.

.. toctree::
   :maxdepth: 1

   installation
   architecture
   api/modules