monasca-analytics/README.md
Daisuke Fujita 474e4b8917 Update README
Currently, README has invalid markup which will not be rendered on PyPI.
This patch updates README to be rendered on PyPI and to be more readable.

Change-Id: Ic081c0729e44f4e09ac21c47a5dbbd0da6deb77f
2019-01-25 11:50:33 +00:00

4.3 KiB

Team and repository tags

Team and repository tags

MoNanas - Monasca Analytics Framework

MoNanas Logo

Overview

Monasca Analytics (MoNanas) is a statistical/machine-learning (SML) flow composition engine. Users can compose a sequence of algorithms to be executed by just providing a description as an input to MoNanas. The data flow is automatically handled by the framework.

Easy flow composition and reusability means that we can speed up the extraction of actionable infrastructure insight.

Advantages

👍 Decouple algorithm design from execution.

👍 Reusable specification of the desired flow.

👍 Language independent flow definition.

👍 Data source and format independent.

👍 Easy to add new SML algorithms and # combine them with pre-existing ones in the flow.

👍 Transparently exploit data parallelism.

Example Use Cases

Documentation

Repositories

Core: https://github.com/openstack/monasca-analytics.git

MoNanas Design

See: MoNanas/Design for details on MoNanas's architecture, its functional requirements and core concepts.

Technologies

MoNanas uses a number of third-party technologies:

Feature Release Schedule

  • Basic SML flow.
  • New algorithm "add-on" ability.
  • Example datasets and SML flows.
  • Support end-to-end learning + data processing flows (currently, the latter part does not get updated due to Spark's immutability.)
  • Refactor codes to be consistent with terms used in the documentation.
  • Add a source, ingestor and transformer for Monasca.
  • Model connections as objects rather than references and have driver specifics in one place.
  • Expanded orchestration abilities/expressiveness.
  • Container-enabled testing/deployment for non-production environments.
  • Add Vitrage Sink.
  • Add a ready-to-use virtual machine image (get rid of the fetch-deps.sh).

Contributing

There are multiple ways to contribute to the project. All are equally important to us!

  • You can have a look at the Monasca launchpad for problems that needs to be solved (bugs/issues), and blueprints.
  • You can also help us to add new learning algorithms.
  • Finally, we are very interested in having more data sources to experiment with. The source can either be from an existing data provider or randomly generated. The more, the better! :) If you are interested to work on that aspect, you are welcome as well.

For more information on setting up your development environment, see MoNanas/DevGuide.

For more information about Monanas, please visit the wiki page: Monanas wiki.

And for more information about Monasca, please visit the wiki page: Monasca wiki.

License

Copyright (c) 2016 Hewlett Packard Enterprise Development Company, L.P. Licensed under the Apache License, Version 2.0 (the "License"); you may not used this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.